blarf

静态网站生成器

文档

安装

需要 Rust。

选项 1 -- 安装到 ~/.cargo/.bin/

cargo install blarf

选项 2 -- 安装到 /usr/local/bin

make
make install

说明

blarf 会查找包含 markdown 文章的目录，以及可选的样式表、电子邮件地址和包含静态资产的目录。如果没有提供样式表，blarf 将使用默认样式表。

blog_src/
|_ styles.css
|_ articles/
| |_ 1-my_first_post.md
| |_ 2-neat_stuff.md
|_ public/
| |_ img/
| | |_ face.png
| | |_ vacation.png
| |_ other_stuff/
|   |_ cv.pdf

运行 blarf 以创建网站。

blarf \
--email me@example.com \
--css blog_src/styles.css  \
--static blog_src/public \
--dest my_site

您将得到如下输出目录

my_site/
|_ index.html
|_ styles.css
|_ img/
| |_ face.png
| |_ vacation.png
|_ other_stuff/
| |_ cv.pdf
|_ articles/
| |_ 1-my_first_post.html
| |_ 2-neat_stuff.html

提供服务和享受。

文章结构

为了获得最佳效果，文章应遵循一些约定

• 文章按 articles 目录中出现的顺序列出，因此您可能希望将数字添加到文件名前，例如 1-my_first_post.md, 2-neat_stuff.md 等。
• 每个 markdown 文档应在某处有一个顶级标题（例如单个井号，例如 # My first post!）。这将成为页面 HTML 中的文章标题以及在页脚中历史链接列表中的标题。
• 如果您使用默认样式，可以使用以下内容
  • 4 级标题显示副标题，例如日期，例如 #### November 24, 2018
  • 5 级标题显示特殊格式的签名：例如 ##### TR
  • 带有作者的引用块获得特殊格式化，例如

    <blockquote>
      <p>All things must pass.</p>
      <p class="author">George Harrison</p>
    </blockquote>
    

  • 在图例中的图像和标题获得特殊格式化，例如

    <figure>
      <img src="/img/Sint_Servaasbrug.jpg" alt="Sint Servaasbrug" />
      <figcaption>Sint Servaasbrug</figcaption>
    </figure>