亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專欄INFORMATION COLUMN

文檔生成工具 idoc

ASCH / 1413人閱讀

摘要：文檔生成工具簡(jiǎn)介通過(guò)生成靜態(tài)頁(yè)面的工具。通過(guò)生成靜態(tài)頁(yè)面的工具本地存儲(chǔ)操作本地操作瀏覽器各種方法通知常用命令測(cè)試工具快捷鍵源碼倉(cāng)庫(kù)倉(cāng)庫(kù)地址歡迎提需求和，提交地址。運(yùn)行預(yù)覽生成的靜態(tài)頁(yè)面。監(jiān)控文件發(fā)生變化自動(dòng)。

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"



簡(jiǎn)介

通過(guò)markdown生成靜態(tài)頁(yè)面的工具。經(jīng)常用 markdown 寫(xiě)一些接口文檔，為了方便特寫(xiě)此工具玩耍。生成的頁(yè)面預(yù)覽效果

這些文檔是都是使用idoc生成的頁(yè)面哦，可以提交用idoc生成的文檔哦提交收錄。

JSLite.io - 這個(gè)是現(xiàn)代瀏覽器類似jQuery的庫(kù)，體積小。

idoc - 通過(guò)markdown生成靜態(tài)頁(yè)面的工具

store.js - js本地存儲(chǔ)操作

cookie.js - js本地cookie操作

iNotify - 瀏覽器各種方法通知

Backbone.js

Lua5.3

git

gulp-book

shell常用命令

測(cè)試工具

chai

mocha

should

快捷鍵

Sketch

bash

sublime

源碼倉(cāng)庫(kù)

倉(cāng)庫(kù)地址【https://github.com/jaywcjlove/idoc】 歡迎提需求和bug，提交地址
issues 。

全局安裝 
$ npm install idoc -g
使用方法

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

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

導(dǎo)航菜單是根據(jù) md 里面的文件目錄結(jié)構(gòu)生成 導(dǎo)航菜單。

在 test 文件夾根目錄初始化運(yùn)行 idoc init 命令，自動(dòng)生成 package.json 文件。

生成靜態(tài)頁(yè)面，運(yùn)行 idoc build 命令。

運(yùn)行 idoc server 預(yù)覽生成的靜態(tài)頁(yè)面。默認(rèn)預(yù)覽地址為 http://localhost:1987/。

這個(gè)時(shí)候你可以將生成的文件上傳至 github 的 gh-pages 分支中，外網(wǎng)預(yù)覽。

命令文檔

命令使用幫助。

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

初始化文檔文件

# 默認(rèn)生成模板和配置文件，將當(dāng)前文件夾根目錄的所有md文件參數(shù)生成到配置文件package.json中
$ idoc init
# 將指定的 md 文件拷貝到當(dāng)前目錄下，生成模板和配置文件
$ idoc init ~/md/JSLite.md
# 將指定的兩個(gè) 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”兩個(gè) md 文件拷貝到指定目錄 `~/idoc/` 下面
# 生成模板需要的文件
# 第一個(gè) md 文件是首頁(yè)
$ idoc init JSLite.md hotkeys.md -C ~/idoc/
build

生成靜態(tài) HTML 頁(yè)面到指定目錄中。

$ idoc build
watch

監(jiān)控 md 文件發(fā)生變化自動(dòng) build。

$ idoc watch
server

打開(kāi)本地靜態(tài) html 服務(wù)器，預(yù)覽你生成的頁(yè)面。

$ idoc server
clean

清除生成的靜態(tài)文件。

$ idoc clean
提交收錄

在 issues 中提交你的連接，我講收錄在此。格式如下：

# 我的 xxx 使用 idoc 生成文檔
[文檔名稱](連接地址)
TODO

[x] idoc 基本命令定義

[x] 添加 build 命令，markdown生成靜態(tài)頁(yè)面

[x] 添加 watch 命令，監(jiān)控markdown文件自動(dòng)生成HMTL頁(yè)面

[x] 默認(rèn)模板制作

[x] 樹(shù)形菜單生成

[x] 添加 server 命令，預(yù)覽生成的靜態(tài)頁(yè)面

[x] 添加多頁(yè)面導(dǎo)航菜單

[x] 添加 clean 命令

[x] 靜態(tài)資源相對(duì)路徑引用

[ ] 判斷是否存在markdown樹(shù)形導(dǎo)航菜單

[ ] 第二個(gè)模板制作

[ ] 模板切換命令

[ ] api 檢索功能

[x] 兼容windows路徑(cmd工具冒得問(wèn)題嘞)

關(guān)注公眾號(hào)

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/86030.html

相關(guān)文章

  • 優(yōu)于 swagger 的 java markdown 文檔自動(dòng)生成框架-01-入門使用

    摘要：很多項(xiàng)目不寫(xiě)文檔，即使寫(xiě)文檔，對(duì)于開(kāi)發(fā)人員來(lái)說(shuō)也是非常痛苦的。無(wú)法保證及時(shí)更新。是基于注解的文檔生成工具。讓文檔的閱讀者享受到等同于手寫(xiě)文檔的體驗(yàn)。將信息的獲取和生成區(qū)分開(kāi)?；谠淖⑨專M可能的生成簡(jiǎn)介的文檔。 設(shè)計(jì)初衷 節(jié)約時(shí)間 Java 文檔一直是一個(gè)大問(wèn)題。 很多項(xiàng)目不寫(xiě)文檔，即使寫(xiě)文檔，對(duì)于開(kāi)發(fā)人員來(lái)說(shuō)也是非常痛苦的。 不寫(xiě)文檔的缺點(diǎn)自不用多少，手動(dòng)寫(xiě)文檔的缺點(diǎn)也顯而易見(jiàn)：...

    RdouTyping 評(píng)論0 收藏0

  • javascript之iframe

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

    Enlightenment 評(píng)論0 收藏0

  • iframe,我們來(lái)談一談

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

    awesome23 評(píng)論0 收藏0

  • ssr無(wú)需等待，讓前端獨(dú)立于后端進(jìn)行開(kāi)發(fā)

    摘要：大家肯定遇到過(guò)，當(dāng)后端沒(méi)有編寫(xiě)完成時(shí)，前端無(wú)法進(jìn)行調(diào)試，這就導(dǎo)致了前端會(huì)被后端阻塞的情況。強(qiáng)制跨域訪問(wèn)請(qǐng)求不報(bào)錯(cuò)啟動(dòng)多個(gè)服務(wù)，自動(dòng)解決端口沖突設(shè)置指定端口號(hào)全局安裝命令幫助。 ssr showImg(https://segmentfault.com/img/bVyhY9); 將一個(gè)目錄設(shè)置成一個(gè)靜態(tài)服務(wù)器。。大家肯定遇到過(guò)，當(dāng)后端 API 沒(méi)有編寫(xiě)完成時(shí)，前端無(wú)法進(jìn)行調(diào)試，這就導(dǎo)致了前...

    Java_oldboy 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

最新活動(dòng)
閱讀需要支付1元查看
<