文檔生成工具 idoc

ASCH 發布于2019-08-21 10:42 / 1354人閱讀

摘要：文檔生成工具簡介通過生成靜態頁面的工具。通過生成靜態頁面的工具本地存儲操作本地操作瀏覽器各種方法通知常用命令測試工具快捷鍵源碼倉庫倉庫地址歡迎提需求和，提交地址。運行預覽生成的靜態頁面。監控文件發生變化自動。

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生成的文檔哦提交收錄。

JSLite.io - 這個是現代瀏覽器類似jQuery的庫，體積小。

idoc - 通過markdown生成靜態頁面的工具

store.js - js本地存儲操作

cookie.js - js本地cookie操作

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

使用方法

任意目錄下新建test文件夾，并進入test文件夾如：mkdir test && cd test。

在你在的目錄下面建立 md 文件夾專門放你的所有 md 文件。

導航菜單是根據 md 里面的文件目錄結構生成導航菜單。

在 test 文件夾根目錄初始化運行 idoc init 命令，自動生成 package.json 文件。

生成靜態頁面，運行 idoc build 命令。

運行 idoc server 預覽生成的靜態頁面。默認預覽地址為 http://localhost:1987/。

這個時候你可以將生成的文件上傳至 github 的 gh-pages 分支中，外網預覽。

命令文檔

命令使用幫助。

Usage: idoc [options]

Options:

  -h, --help           output usage information
  -V, --version        output the version number
  -C, --Create   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工具冒得問題嘞)

關注公眾號

GPU云服務器云服務器接口文檔生成工具文檔生成 python生成文檔 python文檔生成

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/86030.html

優于 swagger 的 java markdown 文檔自動生成框架-01-入門使用

摘要：很多項目不寫文檔，即使寫文檔，對于開發人員來說也是非常痛苦的。無法保證及時更新。是基于注解的文檔生成工具。讓文檔的閱讀者享受到等同于手寫文檔的體驗。將信息的獲取和生成區分開。基于原生的注釋，盡可能的生成簡介的文檔。設計初衷節約時間 Java 文檔一直是一個大問題。很多項目不寫文檔，即使寫文檔，對于開發人員來說也是非常痛苦的。不寫文檔的缺點自不用多少，手動寫文檔的缺點也顯而易見：...

RdouTyping 2019-08-16 15:53 評論0 收藏0
javascript之iframe

摘要：可取得子窗口的對象。獲取頁面高度父子頁面互訪子訪問父等到的信息父訪問子等到的信息 iframe可以做的事情：實現跨域解決IE6下select遮擋不住的問題解決ajax的前進后退問題實現異步上傳 iframe基本知識 iframe元素會創建包含另外一個文檔的內聯框架操作iframe 1）隱藏iframe表框設置frameborder為0； ...

Enlightenment 2019-08-22 12:45 評論0 收藏0
iframe,我們來談一談

摘要：通常我們可以在后配置各種指定資源路徑，有如果你未指定的話，則是使用規定的加載策略默認配置就是同域這里和有一點瓜葛的就是和就是用來指定的有效加載路徑。某大咖說: iframe是能耗最高的一個元素，請盡量減少使用某大牛說: iframe安全性太差，請盡量減少使用...wtf, 你們知不知道你們這樣澆滅了多少孩紙學習iframe的熱情和決心。雖然，你們這樣說的我竟無法反駁，但是ifram...

awesome23 2019-08-21 13:29 評論0 收藏0
ssr無需等待，讓前端獨立于后端進行開發

摘要：大家肯定遇到過，當后端沒有編寫完成時，前端無法進行調試，這就導致了前端會被后端阻塞的情況。強制跨域訪問請求不報錯啟動多個服務，自動解決端口沖突設置指定端口號全局安裝命令幫助。 ssr showImg(https://segmentfault.com/img/bVyhY9); 將一個目錄設置成一個靜態服務器。。大家肯定遇到過，當后端 API 沒有編寫完成時，前端無法進行調試，這就導致了前...

Java_oldboy 2019-08-22 10:58 評論0 收藏0