说明与建议

Markdown是什么

  • Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。
  • Markdown 语言在 2004 由约翰·格鲁伯（英语：John Gruber）创建。
  • Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  • Markdown 编写的文档后缀为 .md

MkDocs 是什么

  • MkDocs 是一个用于创建项目文档的 快速，简单 ，完美华丽 的静态站点生成器。文档源码使用 Markdown 来撰写，用一个 YAML 文件作为配置文档.

Recommend

  • 如果希望自己所写的markdown可以兼容各个markdown编辑器，那么只需了解markdown的传统语法即可，这里推荐一篇文章Markdown基本语法。

  • 如果想让自己所写的markdown发布到web服务器，例如GitHub Pages、自己搭建的HTTP Server，那么可以考虑使用本文所介绍的语法，以实现丰富多样的渲染效果。

  • 笔者建议：尽量使用传统语法，只在必要时候才使用本文介绍的语法。因为排版简洁、条理清晰才能带来最舒服的阅读感受。