NiQin
updated at
2022-10-06 12:25:42+08:00
Hits:
48015
Keys/tags:
markdown
markdown-guide
markdown-指南
Markdown 是一种在 web 上设置文本样式的方法:使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。
你可以使用 Markdown 对文档的展示格式进行排版:如将文本格式化为粗体或斜体、添加图像,以及创建列表等。大多数情况下,Markdown只是一些普通文本加上一些非字母字符,比如 # 或者 *。
Markdown 文档可以通过一些如 mdBook、gitBook 等应用转换为 HTML、PDF、DOC 等格式,提供给不同的应用场景。
Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强,因此使用非常广泛。如 GitHub、WordPress 等,使用 Markdown 对平台上的写作形式进行样式化,提供了 Markdown 文档直接展示的功能。
NiQin
updated at
2022-10-06 09:29:14+08:00
Hits:
77895
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.