目录

• 优先级
• 安装
• 基本用法
• 主题和模板
• 仓库活动
• 贡献指南
• 许可证

优先级

QuickStatic 网站应首先显示内容，然后隐藏主题或配置细节。我们花费的时间比编辑网站模板和配置多。我们应该利用 markdown 中的功能，如指令和自定义属性，为 markdown 添加功能和组件，而不是支持 MDX。QuickStatic 生成静态网站，并专注于以灵活和快速的方式完成。此项目优先考虑以下原则

• 简单性。
• 稳定性（功能较少——不应有很大变化）。
• 内容优先。
• 非常灵活的 markdown，通过扩展的 markdown 规范。
• 不支持 MDX（Markdown 中的 React）。相反，依赖于 markdown 指令和 markdown 属性扩展规范。
• 不支持资产管理或 SCSS 或 LESS 或任何其他自动化转换器支持。
• 基于 Shopify liquid 模板构建。
• 优先考虑生产力。

安装

可以使用以下 cargo 命令安装 QuickStatic（如果您还没有安装 Rust Cargo，应阅读 Cargo 安装指南）。

cargo install quickstatic

基本用法

• Quickstatic 主题应位于 _quickstatic/themes/ 目录下。
• Quickstatic 公共或构建目录是 quickstatic/public。
• 根目录中的所有内容都将按此顺序复制到输出目录中，同时 markdown 文件将被编译成 HTML 文件。
• 任何具有 .liquid 扩展名的文件都将作为模板执行，并且将删除 .liquid 扩展名。例如，sitemap.xml.liquid 将被评估并变为 sitemap.xml。

要构建网站，请运行以下命令

quickstatic build

要监视更改并持续重建网站，请运行以下命令

quickstatic serve

主题和模板

QuickStatic 主题可以使用 Shopify Liquid 模板语言 编写。要为特定页面使用任何模板文件，只需从前缀中引用模板文件。例如

---
title: Page title
layout: themeName/blog/index.liquid
---

Page Content.

这非常灵活，允许您从一个 QuickStatic 网站引用多个主题。

[!TIP]

所有主题都存在于 _quickstatic/themes/ 文件夹中，您的 QuickStatic 网站附带一个名为 default 的默认主题。

仓库活动

贡献指南

1. 分叉存储库（了解如何操作）。

2. 按照如下方式克隆分叉后的存储库

git clone https://github.com/<your username>/quickstatic.git && cd quickstatic

3. 安装所需的依赖和配置。

4. 创建一个新分支，如下所示

git checkout -b <new-branch-name>

5. 做出您的更改，添加测试，并确保测试仍然通过。

6. 将您的提交推送到您的分叉并创建一个拉取请求（了解如何操作）。

7. 做得好！有人会处理您的拉取请求，提供一些反馈或将其合并。

许可证

此存储库在 MIT 许可下发布。