帮酷LOGO
0 0 评论
  • 显示原文与译文双语对照的内容
文章标签:RUST  MARK  文件  BOO  Markdown  files  IMP  GIT  
Create book from markdown files. Like Gitbook but implemented in Rust

  • 源代码名称:mdBook
  • 源代码网址:http://www.github.com/rust-lang-nursery/mdBook
  • mdBook源代码文档
  • mdBook源代码下载
  • Git URL:
    git://www.github.com/rust-lang-nursery/mdBook.git
  • Git Clone代码到本地:
    git clone http://www.github.com/rust-lang-nursery/mdBook
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/rust-lang-nursery/mdBook
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
  • mdBook
    /OS X
    Windows

    mdBook是一个利用 Markdown 文件创建现代联机图书的工具。

    :它看起来像什么

    在中使用用户指南,并使用mdBook生成在线图书,如你可以阅读的网站。 文档使用了GitHub上最新版本并展示了可用的特性。

    安装

    安装mdBook有多种方法。

    二进制

    二进制可以在这里下载 请确保将路径的路径放入到 PATH 中。

    从 Crates.io 收费

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

    
    cargo install mdbook
    
    
    
    

    这将为你下载和编译 mdBook,唯一需要做的就是将货物bin目录添加到你的PATH 中。

    自动部署注意

    使用脚本或者其他CI服务器执行自动部署时,建议你在通过脚本安装mdBook时指定版本范围。

    这将限制服务器安装 latests non版本,并防止你的图书因我们发布新版本而无法构建。 例如:

    
    cargo install mdbook --vers"^0.1.0"
    
    
    
    

    Git

    发布到 crates.io的版本将如此轻微地被 behind 所承载。 如果你需要最新版本,你可以自己构建mdBook的git版本。 Cargo !

    
    cargo install --git https://github.com/rust-lang-nursery/mdBook.git mdbook
    
    
    
    

    再次,确保将货物bin目录添加到你的PATH

    捐赠 英镑

    如果要对mdBook作出贡献,则必须在本地计算机上克隆存储库:

    
    git clone https://github.com/rust-lang-nursery/mdBook.git
    
    
    
    

    cd 进入 mdBook/ 并运行

     
    cargo build
    
    
    
     

    结果二进制可以在 mdBook/target/debug/ 中找到,在 NAME mdBook 或者 mdBook.exe 下。

    用法

    mdBook主要被用作 命令行 工具,尽管它将它的所有功能作为 Rust 框,用于集成它的他项目。

    下面是你要运行的主要命令。 有关详细说明,请查看用户指南

    • mdbook init

      init命令将创建一个目录,其中包含最小的样板,以。

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

      booksrc 都是目录。 src 包含将用于将输出呈现到 book 目录的Markdown 文件。

      请看一下文档了解更多信息和一些技巧。

    • mdbook build

      下面的命令可以运行本书,读取 SUMMARY.md 文件,了解本书的结构,获取源目录中的Markdown 文件,并将你可以上传到服务器的static html页面作为输入。

    • mdbook watch

      运行这里命令时,mdbook将在每次更改时查看 Markdown 文件以重建本书。 这样就不必再回到终端来输入 mdbook build

    • mdbook serve

      mdbook watch 相同,但在发生更改时还会在 http://localhost:3000 ( 端口可变) 上服务本书并重新加载浏览器。

    • mdbook clean

      删除生成的图书所在的目录。

    除了 命令行 接口之外,这个板条箱也可以用作库。 这意味着你可以将它集成到一个现有项目中,例如一个网络应用程序。 由于 命令行 接口只是库功能的包装器,当你使用这个库时,你可以使用 命令行 接口的所有功能。

    请参阅用户指南API文档了解更多信息。

    捐赠

    捐赠非常感谢和鼓励 ! 不要犹豫参与问题的讨论,提出新特性并寻求帮助。

    我们将为你提供一系列的服务,以便你能够轻松地完成安装 Bug 或者添加新功能的过程 ! 如果你需要帮助,请告诉我们。

    更多关于贡献的信息,请查看我们的贡献指南帮助你完成构建和捐赠过程 !

    此外,还提供了一个版本的最新API文档,用于那些对的黑客攻击。

    许可证

    本库中的所有代码都是在 LICENSE下发布的,有关更多信息,请查看许可协议文件。



    文章标签:文件  IMP  files  BOO  GIT  MARK  Markdown  RUST  

    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语