3.0.1 • Published 5 years ago

filedoc v3.0.1

Weekly downloads
17
License
-
Repository
github
Last release
5 years ago

markdown单页文档

想用markdown编写带索引的单页结构HTML文档的话,可以试试。

安装

npm install filedoc -g

使用

首先参考demo/目录,使用markdown编写一些章节文件(位于demo/section/),并使用HTML编写好页面模板文件(位于demo/index.tpl)。在模板文件中,使用x-markdown标签引用.md文件,并使用x-index标签指定索引输出位置。

准备好所有文件后,使用以下命令将模板文件编译为HTML文件。

filedoc index.tpl

如果希望生成的index.html好看一些,可以在style.css里修改添加CSS样式。

  • 可以使用 demo命令生成结构目录,命令如下:

filedoc demo

在生成的目录中,section中是添加的文档章节,index.tpl 是模板,需要把section中的各个markdown文件按照顺序格式在index.tpl中添加,最后使用 filedoc index.tpl 进行编译,会在本目录下生成html文件

————————————————————————————————————————————————————————————————

filedoc tree index.tpl

编辑indexx.tpl模板,生成菜单,h2为父级,h3为子级