mdpage

简单文档工具

mdPage 是一个最小化、有观点的命令行工具（和 Rust 包）用于从 Markdown 文件创建单页 HTML 文档。

演示

mdPage 文档 是使用来自 Markdown 源文件的 mdpage CLI 工具生成的。文档中列出了更多示例，源代码位于 docs 目录中。

安装

安装 mdPage 有多种方式。

1. 二进制文件

   二进制文件可供下载 此处。请确保将二进制文件的路径添加到您的 PATH 中。

2. 从 Crates.io

   这需要安装 Rust 和 Cargo。安装 Rust 后，在终端中键入以下内容

   cargo install mdpage
   

   这将为您下载并编译 mdPage，剩下的就是将 Cargo 二进制目录添加到您的 PATH 中。

用法

mdpage 工具接受一个参数，即包含所有 Markdown 内容的根路径目录。

$ mdpage --help
mdpage 0.1.1
Generate simple documentation

USAGE:
    mdpage [FLAGS] [OPTIONS] <path>

FLAGS:
        --full-page    Generate full page documentation
    -h, --help         Prints help information
    -V, --version      Prints version information

OPTIONS:
    -o, --output <output>        The output file
        --subtitle <subtitle>    Subtitle of the document
        --title <title>          Title of the document

ARGS:
    <path>    Path for the directory containing data

运行该工具的结果始终是一个 index.html 文件。

示例工作流程

$ ls ./examples/basic | sort
page1.md
page2.md
readme.md

$ mdpage ./examples/basic

$ ls ./examples/basic | sort
index.html
page1.md
page2.md
readme.md

$ open index.html

许可证

Apache-2.0