技术文档浏览器扩展
Technical Document Browser Extension

1. 概述

这是一个为 《技术文档标准》《技术文档 Markdown 扩展》 设计的 Chrome / Edge / Firefox / Opera 浏览器扩展,本扩展会渲染浏览器打开的本地 ".md" 文件。

2. 安装

在浏览器的应用商店、扩展商店、组件商店等等中搜索 "Technical Document" 选择下载、安装、获取等等。

3. 用途

3.1. 以 Web 方式浏览 ".md" 文件

3.1.1. 默认情况下,本扩展工作在 Web 模式。 3.1.2. Web 模式下,内容会被渲染为 Web 页。 3.1.3. 默认情况下,扩展会对标题、段落进行多级编号。 3.1.4. Web 模式下,当二级标题为“目录”时,会激活自动目录功能。

3.2. 以 Markdown 高亮方式浏览 ".md" 文件

3.2.1. 通过“文档配置”,可以让扩展工作在 Markdown 模式。 3.2.2. Markdown 模式下,内容将被渲染为基本的 Markdown,并高亮显示。 3.2.3. 默认情况下,扩展会对标题、段落进行多级编号。

3.3. 导出 HTML 文件

3.3.1. 在 Web 模式下,点 Export,可以导出 ".html" 文件。 3.3.2. 导出的文件带标题、段落多级编号。 3.3.3. 导出的文件自带样式表。 3.3.4. 导出的文件中不含嵌入在内容中的图片,将其与相应的 ".md" 文件放在一起,能确保图片显示正常。

3.4. 导出 Markdown 文件

3.4.1. 在 Markdown 模式下,点 Export,可以导出 ".md" 文件。 3.4.2. 导出的文件带标题、段落多级编号。 3.4.3. 导出的文件使用最基本的 Markdown 语法,兼容 GitHub、知乎、简书、掘金等各种内容平台。

3.5. 打印为 PDF 或纸质文件

3.5.1. 在 Web 模式下,点 Print,可以将内容打印为 PDF 或纸质文件。 3.5.2. 打印时,扩展会自动生成封面。 3.5.3. 打印时,扩展会识别文档结构,自动完成分页。 3.5.4. 打印时,“打印机”选择“另存为 PDF”能保留超链接。

4. 文档配置

4.1. 可以用文档配置控制扩展对文档的渲染行为。 4.2. 配置开始于文档第一行的 "---"。 4.3. 配置结束于 "---"。 4.4. 配置项采用 YAML 的对象语法。 4.5. 可配置项及其默认值、可选值、说明:

---
mode: web       # web/markdown/off,渲染模式
numbering: true # true/false,多级编号开关
h1Center: true  # true/false,一级标题居中
h2Center: false # true/false,二级标题居中
width: 52       # number,文档宽度
tocMinLevel: 2  # number,目录的最低级别
tocMaxLevel: 3  # number,目录的最高级别
---

5. 特定标题

5.1. 程序会按照《技术文档标准》的规定,对某些特定的二级标题及其内容进行特殊处理。 5.2. 这些特定标题包括:

6. 其他扩展

6.1. 公式渲染 Formula Render —— TeX All the Things 6.2. 图表渲染 Diagram Render —— Markdown Diagrams 6.3. 动态目录 Create a TOC —— Smart TOC