資訊專(zhuān)欄INFORMATION COLUMN
摘要：文件一鍵生成目錄支持優(yōu)雅的寫(xiě)法支持多次生成支持重復(fù)標(biāo)題的生成支持特殊字符的過(guò)濾支持指定不同的文件編碼支持文件夾的文件批量處理可指定是否包含子文件夾文件支持是否寫(xiě)入文件，可返回目錄的內(nèi)容，便于用戶自行處理環(huán)境依賴(lài)請(qǐng)確保設(shè)置正確。
業(yè)務(wù)需要
在編寫(xiě) github 項(xiàng)目時(shí)，有時(shí)候會(huì)編寫(xiě)各種 README.md 等 markdown 文件，但是 github 默認(rèn)是沒(méi)有目錄的。
于是就自己想辦法寫(xiě)了一個(gè)小工具。
markdown-tocmarkdown-toc 可以用來(lái)生成 markdown 頁(yè)面的目錄，便于 github 頁(yè)面展現(xiàn)。
FeaturesGithub Markdown 文件一鍵生成目錄
支持 fluent 優(yōu)雅的寫(xiě)法
支持多次生成
支持重復(fù)標(biāo)題的生成
支持特殊字符的過(guò)濾
支持指定不同的文件編碼
支持文件夾的文件批量處理(可指定是否包含子文件夾文件)
支持是否寫(xiě)入文件，可返回目錄的內(nèi)容，便于用戶自行處理
...
環(huán)境依賴(lài) JDKJDK7+, 請(qǐng)確保 JDK 設(shè)置正確。
MavenJar 使用 Maven 進(jìn)行統(tǒng)一管理。
快速入門(mén) maven 引入md 文件com.github.houbb markdown-toc 1.0.2
本項(xiàng)目支持的 md 文件后綴名稱(chēng)為 .md 或者 .markdown
快速開(kāi)始單個(gè)文件
AtxMarkdownToc.newInstance().genTocFile(path);
其中 path 為 md 文件的路徑
指定文件夾
AtxMarkdownToc.newInstance().genTocFile(path);
其中 path 為 md 文件的父類(lèi)文件夾
屬性配置代碼示例
AtxMarkdownToc.newInstance()
.charset("UTF-8")
.write(true)
.subTree(true);
屬性說(shuō)明
| 序號(hào) | 屬性 | 默認(rèn)值 | 說(shuō)明 |
|---|---|---|---|
| 1 | charset | UTF-8 | 文件編碼 |
| 2 | write | true | 是否將 toc 寫(xiě)入文件(默認(rèn)寫(xiě)入) |
| 3 | subTree | true | 是否包含子文件夾的文件(默認(rèn)包含) |
genTocFile() 返回 TocGen，genTocDir() 返回 List
TocGen 屬性說(shuō)明
| 序號(hào) | 屬性 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| 1 | filePath | String | 當(dāng)前 md 的文件路徑 |
| 2 | tocLines | List |
當(dāng)前 md 文件對(duì)應(yīng)的目錄內(nèi)容 |
單個(gè)文件-目錄生成測(cè)試案例
文件夾-目錄生成測(cè)試案例
github 地址markdown-toc
文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址：http://systransis.cn/yun/71584.html
摘要：目前支持的解析引擎更新已經(jīng)存在的文章目錄。生成鏈接風(fēng)格的文章目錄。默認(rèn)值用于控制保存文件時(shí)是否自動(dòng)更新已有文章目錄。我使用的與相關(guān)的插件解決文章目錄的問(wèn)題。 如果你使用 Vim 編輯 Markdown，而且也為如何生成和更新文章目錄（Table of Contents）而煩惱，那么如下的內(nèi)容將帶你脫離刀耕火種手寫(xiě) Toc 的體驗(yàn)，回歸使用 Markdown 是為了專(zhuān)注于內(nèi)容的初心。 一...
摘要：而且通常來(lái)說(shuō)，是用來(lái)介紹項(xiàng)目，而不是展示文檔。如果不確定系統(tǒng)中是否已經(jīng)安裝了，使用下面的命令檢查如果出現(xiàn)了的版本號(hào)，則不需要再安裝了。例如我執(zhí)行的命令如下然后使用進(jìn)入項(xiàng)目目錄，并創(chuàng)建一個(gè)名為的目錄目錄將存放我們的文檔。 當(dāng)我們發(fā)布一個(gè)開(kāi)源項(xiàng)目的時(shí)候，最重要的事情之一就是要?jiǎng)?chuàng)建項(xiàng)目文檔。對(duì)使用項(xiàng)目的用戶來(lái)說(shuō)，文檔是非常有必要的，通常我們可以使用下面這些方式來(lái)創(chuàng)建文檔： GitHub W...
摘要：代碼如下首頁(yè)的模版博客網(wǎng)站的基本配置菜單生成，這里不講講中的遍歷，然后生成一個(gè)數(shù)組默認(rèn)按發(fā)布時(shí)間排序置頂替換五集成在編譯博客的過(guò)程中，一些操作利用會(huì)簡(jiǎn)單快捷許多。 文章較長(zhǎng)，耐心讀下來(lái)我想你肯定會(huì)有所收獲 : ) 作為一個(gè)技術(shù)人員，見(jiàn)到別人那光鮮亮麗的個(gè)人博客，心里總免不了想搭建自己博客的沖動(dòng)。當(dāng)然，搭建博客的方式有好多種，但是大體上分這兩種： 服務(wù)端數(shù)據(jù)庫(kù)例如：你可以用 Word...
摘要：文檔生成工具簡(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 ,MbMM ,pWWq. ,p6...
閱讀 878·2021-11-15 17:58
閱讀 3689·2021-11-12 10:36
閱讀 3820·2021-09-22 16:06
閱讀 997·2021-09-10 10:50
閱讀 1350·2019-08-30 11:19
閱讀 3331·2019-08-29 16:26
閱讀 978·2019-08-29 10:55
閱讀 3368·2019-08-26 13:48
