Mdblog

点击中文版 README进入中文文档。

具有功能的 Markdown 文件静态站点生成器

• 支持 TeX 风格的数学公式
• 文件路径是文章的 URL
• 文件名是文章标题
• 文章可以隐藏（链接不会插入索引/标签页）

您可以查看 演示站点 来了解 mdblog 的用法。

安装

mdblog 是使用 Rust 语言（2018 版本）实现的，因此您需要 cargo 命令

cargo +nightly install mdblog

mdblog 将安装在您的 cargo 二进制目录中（~/.cargo/bin/）。

命令行界面

mdblog 可以作为命令使用

$ mdblog -h
static site generator from markdown files

USAGE:
    mdblog <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    build    Build the blog static files
    help     Prints this message or the help of the given subcommand(s)
    init     Initialize the blog directory layout
    new      Create a blog post
    serve    Serve the blog, rebuild on change
    theme    Blog theme operations

您也可以查看子命令用法

$ mdblog serve -h
Serve the blog, rebuild on change

USAGE:
    mdblog serve [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -p, --port <port>    Serve the blog at http://127.0.0.1:<port> [default: 5000]

初始化博客

$ mdblog init myblog

博客目录（myblog）布局已初始化

myblog
├── config.toml
├── media
├── posts
│   ├── hello.md
│   └── math.md
└── _themes

• config.toml：博客配置文件
• media：博客媒体目录
• posts：博客文章目录
• posts/hello.md：一篇 Markdown 风格的文章
• _themes：博客主题目录

构建博客

$ cd myblog
$ mdblog build

博客静态文件构建到子目录 _build 中，当前博客目录（myblog）布局是

myblog
├── config.toml
├── media
├── posts
│   ├── hello.md
│   └── math.md
├── _themes
└── _builds

• _builds：生成的静态站点顶级目录

服务博客

$ mdblog serve

自动打开站点索引页面，并在您添加或更改内容时重新生成静态站点

新文章

创建一个标题为 another 的新文章

$ mdblog new another

创建了一个新的 Markdown 文件 posts/another.md，您可以编辑它以创建新文章。

刷新索引页面，您将找到新文章。

config.toml

site_url = ""
site_name = "Mdblog"
site_motto = "Simple is Beautiful!"
footer_note = "Keep It Simple, Stupid!"
media_dir = "media"
build_dir = "_build"
theme = "simple"
theme_root_dir = "_themes"
rebuild_interval = 2
posts_per_page = 20