Teadocs 使用初步

发表于 更新于 分类于 评论数：

简介

Teadocs是一款能够帮你快速构建html文档的工具，基于nodejs，使用markdown编写文档内容，提供内置的搜索技术。Teadocs基于markdown文档自动生成html文档，可复用、可移植，可以任意部署。

可用来编写开源书籍、API文档学习、笔记、学习心得等结构化文档，简洁高效。

安装

需要nodejs>=8.0，npm版本>3，建议安装到全局，可随时通过shell调用。

$ npm install -g teadocs

初始使用

初始化一个文档项目

$ teadcos init mydocs

进入这个文档目录

$ cd mydocs

自动生成项目初始结构，可在编写好tree.md（菜单的配置文件）的情况下，运行以下命令，teadocs可以自动生成md文件。

$ teadocs init

md文档完成后，可执行下面命令编译成html

$ teadocs build

更推荐使用开发模式进行文档编写，进入文档编辑模式后，将监视markdown文件的变化，实时热替换html页面。

$ teadocs dev

菜单配置文件说明

左侧菜单的配置文件是文档根目录下面的tree.md文件，它使用markdown语法。

以初始项目为例，菜单结构如下：

语法完全使用markdown里的无序列表定义语法，要注意以下几点：

  • [] 里的内容表示菜单的标题，如果不写[]则代表这个菜单没有链接仅作为一个菜单名称。

  • () 里的内容表示菜单的markdown文件的地址，并且也代表了生成后的html文件url。

  • +代表了在生成的html里默认展开这个菜单，需要注意的是，这不是markdown的语法，这是teadocs的规定，+一定要写在文本的前面，而不是[的前面。

markdown模版

markdown文件可以使用内置的ejs模版引擎，比如我们可以写个循环：

< % [1,2,3,4].forEach(function () { % >
- 欢迎使用Teadocs文档生成工具
< % }) % >

效果：

  • 欢迎使用Teadocs文档生成工具
  • 欢迎使用Teadocs文档生成工具
  • 欢迎使用Teadocs文档生成工具
  • 欢迎使用Teadocs文档生成工具

代码上传

目前不支持一键上传同步，可通过将根目录下/build文件夹整体上传到github.io文件夹即可，建议使用github desktop工具同步即可。

github.io项目创建使用见前文。