arthur

将Markdown文章转换为静态网页。

安装

您可以使用cargo进行安装

cargo install arthur

用法

USAGE:
    arthur [FLAGS] --input <input> --output <output> --template <template>

FLAGS:
    -h, --help         Prints help information
    -D, --no-digest    Disable JSON digests for listing articles on pages.
    -G, --no-gfm       Disable Github-flavored markdown.
    -M, --no-media     Disable copying files in source directory.
    -V, --version      Prints version information

OPTIONS:
    -i, --input <input>          Input directory with markdown articles and media.
    -o, --output <output>        Output directory.
    -t, --template <template>    HTML template.

设置很简单。拥有一个包含Markdown和图像的目录，如下所示

articles/
    index.md
    hello-world.md
    media/
        image.png
src/
    template.html

并且它编译为

out/
    digest0.json
    index.html
    hello-world.html
    media/
        image.png

使用以下命令

arthur --input articles --template src/template.html --output out

元数据

在YAML中提供元数据，位于文章顶部。它用于指定作者、日期、标签或您在模板中希望使用的任何内容。

---
title: Hello world
author: John Doe
tags: [ example, test ]
---

# Hello world

Lorem ipsum incididunt dolor dolor sit exercitation anim, nostrud ipsum laboris officia consectetur.

模板

文章使用Handlebars模板（1、2）渲染为HTML。

模板具有变量article、url以及每篇文章的元数据。

<h1>{{title}} by {{author}}</h1>
<div>{{{article}}}</div>

渲染的HTML使用{{{article}}}显示。

使用url创建独特的页面，例如主页。

摘要

摘要以JSON文件的形式提供给其他页面用于列出文章。每个摘要项目包含摘要和元数据。可以使用-D、--no-digest禁用。