文档生成工具 idoc

AIP文档生成工具

    ,,        ,,
    db      `7MM
              MM
  `7MM   ,M""bMM  ,pW"Wq.   ,p6"bo
    MM ,AP    MM 6W'   `Wb 6M'  OO
    MM 8MI    MM 8M     M8 8M
    MM `Mb    MM YA.   ,A9 YM.    ,
  .JMML.`Wbmd"MML.`Ybmd9'   YMbmd'

简介

通过markdown生成静态页面的工具。经常用 markdown 写一些接口文档，为了方便特写此工具玩耍。生成的页面预览效果

这些文档是都是使用idoc生成的页面哦，可以提交用idoc生成的文档哦提交收录。

1. JSLite.io - 这个是现代浏览器类似jQuery的库，体积小。

2. idoc - 通过markdown生成静态页面的工具

3. store.js - js本地存储操作

4. cookie.js - js本地cookie操作

5. iNotify - 浏览器各种方法通知

• Backbone.js

• Lua5.3

• git

• gulp-book

• shell常用命令

• 测试工具

  • chai

  • mocha

  • should

• 快捷键

  • Sketch

  • bash

  • sublime

源码仓库

仓库地址【https://github.com/jaywcjlove/idoc】 欢迎提需求和bug，提交地址
issues 。

全局安装

$ npm install idoc -g

使用方法

1. 任意目录下新建test文件夹，并进入test文件夹 如：mkdir test && cd test。

2. 在你在的目录下面建立 md 文件夹专门放你的所有 md 文件。

3. 导航菜单是根据 md 里面的文件目录结构生成 导航菜单。

4. 在 test 文件夹根目录初始化运行 idoc init 命令，自动生成 package.json 文件。

5. 生成静态页面，运行 idoc build 命令。

6. 运行 idoc server 预览生成的静态页面。默认预览地址为 http://localhost:1987/。

7. 这个时候你可以将生成的文件上传至 github 的 gh-pages 分支中，外网预览。

命令文档

命令使用帮助。

Usage: idoc [options]

Options:

  -h, --help           output usage information
  -V, --version        output the version number
  -C, --Create <file>  Select Directory Makefile.
  init                 init a documentation.
  build                Markdown produces static pages document.
  watch                Listener "md" file is automatically generated pages.
  server               Open local static html server.
  clean                Clear the generate static files.

Examples:

  $ idoc init
  $ idoc init [path]
  $ idoc init [path] -C ~/idoc/
  $ idoc watch
  $ idoc server
  $ idoc clean

init

初始化文档文件

# 默认生成模板和配置文件，将当前文件夹根目录的所有md文件参数生成到配置文件package.json中
$ idoc init
# 将指定的 md 文件拷贝到当前目录下，生成模板和配置文件
$ idoc init ~/md/JSLite.md
# 将指定的两个 md 文件拷贝到当前目录下
$ idoc init ~/git/_idc/package.md  ~/git/_idc/dir/directory.md
# 将指定的 _idc 目录下的所有 md 文件拷贝到当前目录下
$ idoc init ~/git/_idc/

# 指定生成模板和配置文件
# 将“JSLite.md hotkeys.md”两个 md 文件拷贝到指定目录 `~/idoc/` 下面
# 生成模板需要的文件
# 第一个 md 文件是首页
$ idoc init JSLite.md hotkeys.md -C ~/idoc/

build

生成静态 HTML 页面到指定目录中。

$ idoc build

watch

监控 md 文件发生变化自动 build。

$ idoc watch

server

打开本地静态 html 服务器，预览你生成的页面。

$ idoc server

clean

清除生成的静态文件。

$ idoc clean

提交收录

在 issues 中提交你的连接，我讲收录在此。格式如下：

# 我的 xxx 使用 idoc 生成文档
[文档名称](连接地址) 

TODO

• [x] idoc 基本命令定义

• [x] 添加 build 命令，markdown生成静态页面

• [x] 添加 watch 命令，监控markdown文件自动生成HMTL页面

• [x] 默认模板制作

• [x] 树形菜单生成

• [x] 添加 server 命令，预览生成的静态页面

• [x] 添加多页面导航菜单

• [x] 添加 clean 命令

• [x] 静态资源相对路径引用

• [ ] 判断是否存在markdown树形导航菜单

• [ ] 第二个模板制作

• [ ] 模板切换命令

• [ ] api 检索功能

• [x] 兼容windows路径(cmd工具冒得问题嘞)

关注公众号