阿卡坦

阿卡坦是 mdBook 的分支。它通过使用 spongedown 为 Markdown 提供了额外的功能。

演示 - 使用此项目生成的 spongedown 生成书籍

Linux / OS X
Windows

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

此项目仍在不断发展。
见 #90

它看起来像什么？

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

安装

安装 mdBook 有多种方式。

2. 从 Crates.io
   这需要安装 Rust 和 Cargo。一旦安装了 Rust，请在终端中输入以下内容

   cargo install aklat
   

   这将为您下载和编译 mdBook，剩下的只是将 Cargo 的 bin 目录添加到您的 PATH 中。

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

   cargo install --git https://github.com/ivanceras/aklat.git
   

   同样，请确保将 Cargo 的 bin 目录添加到您的 PATH 中。

4. 贡献
   如果您想为 mdBook 贡献，您需要在您的本地计算机上克隆仓库

   git clone https://github.com/ivanceras/aklat.git
   

   cd 进入 aklat/ 并运行

   cargo build
   

   生成的二进制文件可以在 mdBook/target/debug/ 下找到，名称为 mdBook 或 mdBook.exe。

用法

mdBook 主要用作命令行工具，尽管它将其所有功能作为 Rust crate 暴露出来，以便在项目中集成。

以下是您想要运行的命令。如需更详细的解释，请查看文档。

• aklat init

  init命令将创建一个包含启动所需最小模板的目录。

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

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

  请查阅文档以获取更多信息以及一些技巧。

• aklat build

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

• aklat watch

  运行此命令时，aklat将监视您的markdown文件，并在每次更改时重建书籍。这样可以避免每次都要回到终端重新输入aklat build。

• aklat serve

  与aklat watch做同样的事情，但此外还将在https://127.0.0.1:3000（端口可更改）处提供书籍服务，并在发生更改时重新加载浏览器。

作为库

除了命令行界面外，此crate还可以用作库。这意味着您可以将其集成到现有项目中，例如一个Web应用。由于命令行界面只是库功能的包装，因此当您将此crate用作库时，您可以完全访问命令行界面的所有功能，以及更易用的API等！

请参阅文档和API文档以获取更多信息。

贡献

我们高度重视并鼓励贡献！请不要犹豫，参与问题讨论，提出新功能，并寻求帮助。

如果您不太熟悉Rust，如果您决定解决一个问题或新功能，我将很乐意尽力指导您。

不熟悉代码的人可以查看被标记为简单的问题标签。许多问题也与Web开发相关，因此不熟悉Rust的人也可以参与！😉

您可以挑选任何您想要解决的问题。通常，询问是否有人正在处理它是个好主意，如果没有，则可以声明该问题。

许可证

所有代码均根据Mozilla Public License v2.0发布，有关更多信息，请参阅许可证文件。