按映射关系配置抓取GitHub中的Markdown文档,并生成相应聚合站点;这是以 Chimee 播放器文档聚合为例子
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 5 commits ahead of huzunjie:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs-src
static/css/docs
.gitignore
README.md
package.json

README.md

文档聚合工具

用于按照docs-src/config.js中的配置,拉取GitHub中相应的*.md文档,放置到docs-src/docs目录,最终生成文档及导航对应的HTML页面到docs目录。

在这里以Chimee播放器文档聚合作为实现示例。

开始

执行 npm install 安装依赖,进行环境初始化。

配置

  1. 导航与文档映射关系配置:docs-src/config.js

    JSON中key是导航或菜单的描述,md_fname是生成静态化HTML页面的名称,md_url是Markdown文档获取路径。

  2. 页面模板配置:docs-src/layout/page.html

  3. 左侧导航生成:docs-src/layout/helpers/navs_helper.js

    另外子菜单(文档索引导航)生成来自正文部分的{{>toc}},和页脚部分的JavaScript。

  4. 文档同步脚本:docs-src/tools/sync-docs.js,基于config.js的映射配置拉取。

同步Markdown文档

执行 npm run sync-docs 逐个遍历配置、并按配置URL拉取对应文档到本地目录。

编译

执行 npm run rebuild 将拉取的文档编译为静态HTML页面到docs目录中。

快捷操作

执行 npm run build 一次完成文件拉取、编译。

发布

复制docsstatic目录到相应站点,并建立链接。