zhangdocs
Version:
Simple document generation tool. Dependence Node.js run.
70 lines (53 loc) • 1.92 kB
Markdown
# AIP文档生成工具
简单的文档生成工具!
# 全局安装
```bash
$ sudo npm install zhangdocs -g
```
# 命令使用
命令使用帮助。
```sh
Usage: zhangdocs [options]
Simple document generation tool!
Options:
-h, --help output usage information
-V, --version output the version number
-C, --Create <file> Select Directory Makefile.
-v App version information.
-i, init Init a documentation.
-b, build Markdown produces static pages document.
-w, watch Listener "md" file is automatically generated pages.
-s, server Open local static html server.
-c, clean Clear the generate static files.
-t, theme Choose a theme.
-d, deploy Publish to a gh-pages branch on GitHub.
Examples:
$ zhangdocs init
$ zhangdocs init [path]
$ zhangdocs init [path] -C ~/zhangdocs/
$ zhangdocs watch
$ zhangdocs server
$ zhangdocs clean
$ zhangdocs deploy
$ zhangdocs theme
$ zhangdocs -t ~/git/zhangdocs-theme-slate/
```
# TODO
- [x] zhangdocs 基本命令定义
- [x] 添加 build 命令,markdown生成静态页面
- [x] 添加 watch 命令,监控markdown文件自动生成HMTL页面
- [x] 默认模板制作
- [x] 树形菜单生成
- [x] 添加 server 命令,预览生成的静态页面
- [x] 添加多页面导航菜单
- [x] 添加 clean 命令
- [x] 静态资源相对路径引用
- [x] github 连接地址添加
- [x] `zhangdocs deploy` === `git push -f origin gh-pages`
- [ ] 配置文件配置下载 md 文件
- [x] 解决server 端口冲突
- [ ] 判断是否存在markdown树形导航菜单
- [x] 第二个模板制作
- [x] 模板切换命令
- [ ] api 检索功能
- [x] 兼容windows路径(cmd工具冒得问题嘞)