MkDocs 文档生成逻辑浅析
来源:互联网 发布:美工助理的基本要求 编辑:程序博客网 时间:2024/05/23 16:55
Markdown 和 MkDocs 简介
Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台 WordPress 和大型 CMS 如 Joomla 、Drupal 都能很好的支持 Markdown 。
MkDocs 是一个用于创建项目文档的快速,简单的静态站点生成器。文档源码使用 Markdown 来撰写,用一个 YAML 文件作为配置文档。
MkDocs 处理的是一系列的 Markdown 文档,然后将 Markdown 文档的内容解析出来,保存在 Python 字典中,最后 Jinja2 模板把内容生成为 html 。
MkDocs 如何将 Markdown 内容解析出来?又是如何将文档内容结构化的?
Markdown 文档解析
使用 Python-Markdown 解析文件,然后返回 html_content ,table_of_contents ,meta 。对内容做了初步的处理,从 markdown 文件,转换为 Python 相关变量。
Python-Markdown 简介
This is a Python implementation of John Gruber’s Markdown. It is almost completely compliant with the reference implementation, though there are a few very minor differences. See John’s Syntax Documentation for the syntax rules.
YAML 配置文件
载入 YAML 的配置,将配置文件的内容读取为 Python 内容。
YAML是一种直观的能够被电脑识别的的数据序列化格式,容易被人类阅读,并且容易和脚本语言交互。YAML类似于XML,但是语法比XML简单得多,对于转化成数组或可以hash的数据时是很简单有效的。
Python 字典
获取页面内容,从 markdown 中解析的内容,存入 Python 字典中,为后续 Jinja2 的调用做准备。
Jinja2 内容生成
载入 Jinja2 模板,结合之前抽取的内容生成 HTML 文件。
Jinja2 是一个现代的,设计者友好的,仿照 Django 模板的 Python 模板语言。 它速度快,被广泛使用,并且提供了可选的沙箱模板执行环境保证安全。
Jinja2 模板文件
toc.html 的代码
模板文件中有之前的 Python 变量,比如 nav.item ,会被替换为对应的内容。
MkDocs 比较巧妙的实现了内容和表现的分离,虽然没有数据库,但是使用了结构化的 markdown 文件,解析为 Python 内容,然后通过 Jinja2 模板,最后生成 HTML。
MkDocs http://www.mkdocs.org/
作者:不知道自己是谁(极光)http://www.jianshu.com/p/c9410da484fb
- MkDocs 文档生成逻辑浅析
- MkDocs 文档生成逻辑浅析
- 文档发布工具mkdocs
- MkDocs 文档编辑器
- MkDocs项目文档生成器(一)
- MkDocs项目文档生成器(二)
- mkdocs
- 使用MKDocs构建Markdown格式API文档(macOS)
- mkdocs安装
- 浅析如何在Nancy中生成API文档
- 浅析逻辑数据映射
- MkDocs 快速入门
- mkdocs 编辑及启动
- 单文档、多文档浅析
- valueStack浅析--文档整理
- 递归生成逻辑树
- Discuz X:家园底层逻辑浅析(1)
- 中低端存储逻辑架构浅析
- 连接
- Redis集群的配置
- CvRect、RECT和Rect
- 详解Javascript中prototype属性
- PB程序优化
- MkDocs 文档生成逻辑浅析
- QWT使用出错
- hdu_1054最小点覆盖树上
- Cloudera Manager下安装kafka
- Java编码约定中对下列部分的要求:类、属性、方法、包、文件名、变量、常量、控制结构、语句行、注释
- Java中常用jar包解释
- DHTML技术演示---类似调查问卷的单选框学习
- 20170412-cpp上机作业【复制构造函数】
- ThinkPHP 3.2.x 集成极光推送指北