資訊專欄INFORMATION COLUMN
摘要：文檔生成工具簡介通過生成靜態(tài)頁面的工具。通過生成靜態(tài)頁面的工具本地存儲操作本地操作瀏覽器各種方法通知常用命令測試工具快捷鍵源碼倉庫倉庫地址歡迎提需求和，提交地址。運行預(yù)覽生成的靜態(tài)頁面。監(jiān)控文件發(fā)生變化自動。
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生成靜態(tài)頁面的工具。經(jīng)常用 markdown 寫一些接口文檔，為了方便特寫此工具玩耍。生成的頁面預(yù)覽效果
這些文檔是都是使用idoc生成的頁面哦，可以提交用idoc生成的文檔哦提交收錄。
JSLite.io - 這個是現(xiàn)代瀏覽器類似jQuery的庫，體積小。
idoc - 通過markdown生成靜態(tài)頁面的工具
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 文件。
導(dǎo)航菜單是根據(jù) md 里面的文件目錄結(jié)構(gòu)生成 導(dǎo)航菜單。
在 test 文件夾根目錄初始化運行 idoc init 命令，自動生成 package.json 文件。
生成靜態(tài)頁面，運行 idoc build 命令。
運行 idoc server 預(yù)覽生成的靜態(tài)頁面。默認(rèn)預(yù)覽地址為 http://localhost:1987/。
這個時候你可以將生成的文件上傳至 github 的 gh-pages 分支中，外網(wǎng)預(yù)覽。
命令文檔命令使用幫助。
Usage: idoc [options] Options: -h, --help output usage information -V, --version output the version number -C, --CreateinitSelect 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
初始化文檔文件
# 默認(rèn)生成模板和配置文件，將當(dāng)前文件夾根目錄的所有md文件參數(shù)生成到配置文件package.json中 $ idoc init # 將指定的 md 文件拷貝到當(dāng)前目錄下，生成模板和配置文件 $ idoc init ~/md/JSLite.md # 將指定的兩個 md 文件拷貝到當(dāng)前目錄下 $ idoc init ~/git/_idc/package.md ~/git/_idc/dir/directory.md # 將指定的 _idc 目錄下的所有 md 文件拷貝到當(dāng)前目錄下 $ idoc init ~/git/_idc/ # 指定生成模板和配置文件 # 將“JSLite.md hotkeys.md”兩個 md 文件拷貝到指定目錄 `~/idoc/` 下面 # 生成模板需要的文件 # 第一個 md 文件是首頁 $ idoc init JSLite.md hotkeys.md -C ~/idoc/build
生成靜態(tài) HTML 頁面到指定目錄中。
$ idoc buildwatch
監(jiān)控 md 文件發(fā)生變化自動 build。
$ idoc watchserver
打開本地靜態(tài) html 服務(wù)器，預(yù)覽你生成的頁面。
$ idoc serverclean
清除生成的靜態(tài)文件。
$ idoc clean提交收錄
在 issues 中提交你的連接，我講收錄在此。格式如下：
# 我的 xxx 使用 idoc 生成文檔 [文檔名稱](連接地址)TODO
[x] idoc 基本命令定義
[x] 添加 build 命令，markdown生成靜態(tài)頁面
[x] 添加 watch 命令，監(jiān)控markdown文件自動生成HMTL頁面
[x] 默認(rèn)模板制作
[x] 樹形菜單生成
[x] 添加 server 命令，預(yù)覽生成的靜態(tài)頁面
[x] 添加多頁面導(dǎo)航菜單
[x] 添加 clean 命令
[x] 靜態(tài)資源相對路徑引用
[ ] 判斷是否存在markdown樹形導(dǎo)航菜單
[ ] 第二個模板制作
[ ] 模板切換命令
[ ] api 檢索功能
[x] 兼容windows路徑(cmd工具冒得問題嘞)
關(guān)注公眾號
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/86030.html
摘要：很多項目不寫文檔，即使寫文檔，對于開發(fā)人員來說也是非常痛苦的。無法保證及時更新。是基于注解的文檔生成工具。讓文檔的閱讀者享受到等同于手寫文檔的體驗。將信息的獲取和生成區(qū)分開?；谠淖⑨專M可能的生成簡介的文檔。 設(shè)計初衷 節(jié)約時間 Java 文檔一直是一個大問題。 很多項目不寫文檔，即使寫文檔，對于開發(fā)人員來說也是非常痛苦的。 不寫文檔的缺點自不用多少，手動寫文檔的缺點也顯而易見：...
摘要：可取得子窗口的對象。獲取頁面高度父子頁面互訪子訪問父等到的信息父訪問子等到的信息 iframe可以做的事情： 實現(xiàn)跨域 解決IE6下select遮擋不住的問題 解決ajax的前進后退問題 實現(xiàn)異步上傳 iframe基本知識 iframe元素會創(chuàng)建包含另外一個文檔的內(nèi)聯(lián)框架 操作iframe 1）隱藏iframe表框 設(shè)置frameborder為0； ...
摘要：通常我們可以在后配置各種指定資源路徑，有如果你未指定的話，則是使用規(guī)定的加載策略默認(rèn)配置就是同域這里和有一點瓜葛的就是和就是用來指定的有效加載路徑。 某大咖說: iframe是能耗最高的一個元素，請盡量減少使用某大牛說: iframe安全性太差，請盡量減少使用...wtf, 你們知不知道你們這樣澆滅了多少孩紙學(xué)習(xí)iframe的熱情和決心。 雖然，你們這樣說的我竟無法反駁，但是ifram...
摘要：大家肯定遇到過，當(dāng)后端沒有編寫完成時，前端無法進行調(diào)試，這就導(dǎo)致了前端會被后端阻塞的情況。強制跨域訪問請求不報錯啟動多個服務(wù)，自動解決端口沖突設(shè)置指定端口號全局安裝命令幫助。 ssr showImg(https://segmentfault.com/img/bVyhY9); 將一個目錄設(shè)置成一個靜態(tài)服務(wù)器。。大家肯定遇到過，當(dāng)后端 API 沒有編寫完成時，前端無法進行調(diào)試，這就導(dǎo)致了前...
閱讀 3690·2021-11-23 09:51
閱讀 1051·2021-11-19 11:30
閱讀 3376·2019-08-29 14:16
閱讀 3383·2019-08-29 12:12
閱讀 2378·2019-08-26 13:40
閱讀 3491·2019-08-26 12:21
閱讀 3085·2019-08-26 11:55
閱讀 2231·2019-08-26 11:35
