中文
R
NiQin shared an aphorism: 我们一直寻找的,却是自己原本早已拥有的;我们总是东张西望,唯独漏了自己想要的,这就是我们至今难以如愿以偿的原因。 -- 柏拉图《理想国》

Others The mdBook Guide/Documentation No.633e2f6a1f92fec312176c40 Alternative URL

NiQin updated at 2022-10-06 09:29:14+08:00

💥 Overview of book & doc

Hits: 61689

Keys/tags: markdown mdbook-guide mdbook-documentation mdbook-指南/文档

Create book from markdown files. Like Gitbook but implemented in Rust.

mdBook is a command line tool to create books with Markdown. It is ideal for creating product or API documentation, tutorials, course materials or anything that requires a clean, easily navigable and customizable presentation.

  • Lightweight Markdown syntax helps you focus more on your content
  • Integrated search support
  • Color syntax highlighting for code blocks for many different languages
  • Theme files allow customizing the formatting of the output
  • Preprocessors can provide extensions for custom syntax and modifying content
  • Backends can render the output to multiple formats
  • Written in Rust for speed, safety, and simplicity
  • Automated testing of Rust code samples

This guide is an example of what mdBook produces. mdBook is used by the Rust programming language project, and The Rust Programming Language book is another fine example of mdBook in action.

All rights of books and documents belong to the authors, editors, and translators, the goal of this site is to facilitate reading. If there is anything improper, please contact ask@rusthub.org.

Read Now Alternative URL