README

🔥 使用 Laravel 的 Blade 模板引擎和利用 JSON 或 Markdown 文件实现超级可扩展内容的闪电般的静态网站生成器。

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

要求

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

npm install

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

npm run dev

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

有一个启动的 JavaScript 文件，它通过 npm 导入 lodash、jQuery 和 Vue 依赖项，可用于您的项目。您可以通过编辑 resources/assets/js/app.js 文件进行修改。

要编译 SCSS/JS 资产并构建静态网站文件，您可以从根目录运行 npm run dev。此外，使用 npm run watch 启动本地节点服务器，您可以使用它来查看编译后的项目，并监视 resources/ 目录中任何资产、视图或内容文件的更改。

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

如果您通过调用 php cleaver build 直接构建网站，以下是目前您可以使用的当前命令及其相关参数列表

php cleaver build {page} 构建 current 网站在 resources/content 目录中渲染内容，并将组织在目录树中的 HTML 输出到 /dist。您可以通过包含一个 page 参数来选择渲染单个页面或内容中的特定路径。（例如，php cleaver build posts/my-cool-post.md）

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

npm run production

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

然后，只要将网站根目录指向 /dist 文件夹，您就可以将整个项目发布到您选择的任何托管服务提供商。此外，您也可以仅将构建的文件发布到 dist 文件夹中。

Cleaver 仍在积极开发中，虽然它旨在保持尽可能简单，但还有一些功能可以使整体体验更好。以下是未来的计划

有任何问题？请在此处提交！想联系我或推荐功能？请随时通过 Twitter 提出任何其他问题或评论。

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