Rough

Rough 是一个非常简单且非常具有偏见的用于生成小型画廊/展示/作品集网站的工具。一旦构建完毕或获取了预构建的可执行文件，只需执行 rough <源目录> <构建目录> 来生成您的网站。例如，rough src out。

源格式

使用此工具生成的网站包含

• 单个HTML索引文件。
• 任意数量的项目文件，每个都有自己的HTML文件。
• 任意数量的静态文件，例如图像、CSS和JavaScript。

以下，src/ 将用作源目录，而 out/ 将用作输出目录。然而，这些可以配置，如上所述。

项目文件

项目文件将从 src/projects 读取。每个项目文件应该是一个带有YAML前端的Markdown文件。它们将被渲染到 out/projects，无论它们的扩展名如何，都将替换为 .html。

必须存在一个名为 src/project.html 的文件。这是一个 Tera 模板，它将被用于渲染每个项目文件。以下上下文变量可用

• meta：YAML前端。
• content：Markdown内容，渲染为HTML。

索引文件

必须存在一个名为 src/index.html 的文件。这也是一个 Tera 模板，这次用于渲染索引文件。仅有一个上下文变量可用：projects。这是一个列表，其中每个元素都是项目文件的YAML前端。

索引文件将渲染到 out/index.html。

静态文件

在 src/static/ 中的任何文件都将递归地复制到 out/static/。

Markdown 风味

Markdown 解析和渲染由 pulldown-cmark 完成，它应符合 CommonMark 标准。以下添加了以下非 CommonMark 扩展：

• GitHub 风格 Markdown (GFM) 表格
• GFM 任务列表
• GFM 删除线
• pulldown-cmark 的脚注
• pulldown-cmark 的智能标点
• pulldown-cmark 的标题属性
• 一个自定义扩展，当段落标签围绕单个图片时，会移除包裹的段落标签。

YAML 前置信息应位于文档开头，由单独的三条横线在其自己的行上界定，位于前置信息之上和之下。例如：

---
title: Hello World!
slug: hello_world
description: My first ever file.
---

Hia!!