文檔生成工具 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工具冒得問題嘞)

關注公衆號