moenarchbook

moenarchbook 是一个从 Markdown 文件创建现代在线书籍的工具。

它看起来像什么？

moenarchbook 的[用户指南]是用 Markdown 编写的，并使用 moenarchbook 生成您可阅读的类似在线书籍的网站。该文档使用 GitHub 上的最新版本，并展示了可用功能。

安装

安装 moenarchbook 有多种方法。

1. 二进制文件

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

2. 从 Crates.io

   这需要至少 [Rust] 1.39 和 Cargo 已安装。安装 Rust 后，在终端中输入以下内容

   cargo install moenarchbook
   

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

   自动部署说明

   如果您正在使用脚本通过 Travis 或其他 CI 服务器进行自动部署，我们建议您在通过脚本安装时指定 moenarchbook 的 semver 版本范围！

   这将限制服务器安装最新的非破坏性版本，并防止由于我们发布了新版本而导致您的书籍构建失败。

   您还可以禁用默认功能以加快编译时间。

   示例

   cargo install moenarchbook --no-default-features --features output --vers "^0.1.0"
   

3. 从 Git

   发布到 Crates.io 的版本将略微落后于 GitHub 上托管的版本。如果您需要最新版本，可以自己构建 moenarchbook 的 Git 版本。Cargo 使这变得 非常简单！

   cargo install --git https://github.com/moenarch/moenarchbook.git moenarchbook
   

   再次提醒，请确保将 Cargo 二进制目录添加到您的 PATH。

使用方法

moenarchbook 主要用作命令行工具，尽管它将其所有功能作为 Rust crate 公开，以便集成到其他项目中。

以下是您希望运行的几个主要命令。有关更详尽的说明，请参阅[用户指南]。

• moenarchbook init<目录>

  init命令将创建一个包含最小模板的目录以开始。如果省略了<directory>参数，则将使用当前目录。

  book-test/
  ├── book
  └── src
      ├── chapter_1.md
      └── SUMMARY.md
  

  book和src都是目录。其中src包含将用于渲染到book目录的markdown文件。

  请参阅[CLI文档]以获取更多信息和一些实用技巧。

• moenarchbook build

  这是您将运行的命令来渲染您的书籍，它读取SUMMARY.md文件以了解您书籍的结构，将源目录中的markdown文件作为输入，并输出可以上传到服务器的静态html页面。

• moenarchbook watch

  运行此命令时，moenarchbook将监视您的markdown文件，并在每次更改时重新构建书籍。这样，您就不必一次次回到终端输入moenarchbook build了。

• moenarchbook serve

  与moenarchbook watch执行相同的操作，但还会在https://127.0.0.1:3000（端口可更改）处提供服务，并在发生更改时重新加载浏览器。

• moenarchbook clean

  删除包含生成的书籍的目录。

许可证

此存储库中的所有代码均根据Mozilla Public License v2.0发布，有关更多信息，请参阅[LICENSE]文件。