README

🔥 使用 PHP 和 Laravel 的 Blade 构建的本地目录的闪电般快速静态网站生成器，利用 JSON 或 Markdown 文件实现超扩展的内容。

composer create-project aschmelyun/cleaver-directory your-site-name

我为什么创建这个

在 COVID-19 爆发期间，我非常想利用我的技能，并为我的社区提供一些能用于积极目的的东西。我决定创建一个展示仍营业的当地餐馆的目录，这将是我时间的完美利用。

我决定使用之前构建的静态网站生成器 Cleaver 作为这个项目的基础，修改并添加功能、基本布局和示例内容。

这样，任何经验水平的开发者都可以克隆这个项目用于他们的地区，使用 Markdown 便捷地添加餐馆或企业，并在像 Netlify 这样的服务上免费部署。

使用 Composer 创建您的项目后，cd 到您的项目根目录并安装节点依赖项

npm install

从那里，您可以使用包含的示例内容构建演示网站，输出到项目根目录中的 dist/ 文件夹

npm run dev

就像主要的 Cleaver 生成器一样，Cleaver Directory 使用 resources/content 目录来存储构成您网站的 Markdown 或 JSON 文件。

默认情况下，有一个名为 listings 的嵌套文件夹，您应该在这里添加您的商店、餐馆和其他企业。当渲染网站时，框架将查找使用 layout.listing 视图的内容，并将这个列表数组传递给索引视图。

个人列表页面是从该 listings 目录中的内容文件构建的。在每一个中，除了视图和路径外，还需要以下变量

请参阅示例内容页面这里，以及主 Cleaver 文档页面的更多文档。

您还可以有纯内容页面（以 submit.md 为例），可用于信息页面、联系区域、常见问题解答等。

Cleaver 使用 SCSS 进行样式设计，并在 resources/assets/sass 目录中设置了一个基本骨架结构。默认导入 Tailwind，以便您可以直接进入快速开发和原型制作。

有一个初始化的 JavaScript 文件，通过 npm 导入 lodash、jQuery 和 Vue 依赖项，可用于您的项目。这可以通过编辑 resources/assets/js/app.js 文件来修改。

要编译SCSS/JS资产和构建静态网站文件，您可以从根目录运行npm run dev。另外，使用npm run watch将启动一个本地Node服务器，您可以用来查看编译后的项目，并且会监视整个resources/目录下任何资产的更改，包括视图或内容文件。

如果您希望在不需要编译资产的情况下构建网站，请从项目根目录运行php cleaver命令。

一旦您准备好发布网站，只需运行以下命令

npm run production

这将压缩您的资产，并使用新版本文件重新构建网站。

然后，您可以将其整个项目发布到您选择的任何主机，只要网站根目录指向/dist文件夹。另外，您也可以只发布dist文件夹中的构建文件。

遇到问题？请在此处提交！想要联系我或有任何功能建议？欢迎在Twitter上与我联系，有任何其他问题或建议。

MIT许可证（MIT）。有关更多详细信息，请参阅LICENSE.md。