為 github markdown 文件生成目錄

Mr_houzi 發布于2019-08-16 12:43 / 2365人閱讀

摘要：文件一鍵生成目錄支持優雅的寫法支持多次生成支持重復標題的生成支持特殊字符的過濾支持指定不同的文件編碼支持文件夾的文件批量處理可指定是否包含子文件夾文件支持是否寫入文件，可返回目錄的內容，便于用戶自行處理環境依賴請確保設置正確。

業務需要

在編寫 github 項目時，有時候會編寫各種 README.md 等 markdown 文件，但是 github 默認是沒有目錄的。

于是就自己想辦法寫了一個小工具。

markdown-toc

markdown-toc 可以用來生成 markdown 頁面的目錄，便于 github 頁面展現。

Features

Github Markdown 文件一鍵生成目錄

支持 fluent 優雅的寫法

支持多次生成

支持重復標題的生成

支持特殊字符的過濾

支持指定不同的文件編碼

支持文件夾的文件批量處理(可指定是否包含子文件夾文件)

支持是否寫入文件，可返回目錄的內容，便于用戶自行處理

...

環境依賴 JDK

JDK7+, 請確保 JDK 設置正確。

Maven

Jar 使用 Maven 進行統一管理。

快速入門 maven 引入


    com.github.houbb
    markdown-toc
    1.0.2

md 文件

本項目支持的 md 文件后綴名稱為 .md 或者 .markdown

快速開始

單個文件

AtxMarkdownToc.newInstance().genTocFile(path);

其中 path 為 md 文件的路徑

指定文件夾

AtxMarkdownToc.newInstance().genTocFile(path);

其中 path 為 md 文件的父類文件夾

屬性配置

代碼示例

AtxMarkdownToc.newInstance()
                .charset("UTF-8")
                .write(true)
                .subTree(true);

屬性說明

序號	屬性	默認值	說明
1	charset	UTF-8	文件編碼
2	write	true	是否將 toc 寫入文件(默認寫入)
3	subTree	true	是否包含子文件夾的文件(默認包含)

返回值說明

genTocFile() 返回 TocGen，genTocDir() 返回 List

TocGen 屬性說明

序號	屬性	類型	說明
1	filePath	String	當前 md 的文件路徑
2	tocLines	List	當前 md 文件對應的目錄內容

測試案例

單個文件-目錄生成測試案例

文件夾-目錄生成測試案例

github 地址

markdown-toc

GPU云服務器云服務器 php生成為txt文件 php生成目錄樹 java的目錄生成 js遞歸生成目錄樹

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

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

Markdown 的文章目錄在 Vim 里的終極解決方案

摘要：目前支持的解析引擎更新已經存在的文章目錄。生成鏈接風格的文章目錄。默認值用于控制保存文件時是否自動更新已有文章目錄。我使用的與相關的插件解決文章目錄的問題。如果你使用 Vim 編輯 Markdown，而且也為如何生成和更新文章目錄（Table of Contents）而煩惱，那么如下的內容將帶你脫離刀耕火種手寫 Toc 的體驗，回歸使用 Markdown 是為了專注于內容的初心。一...

cpupro 2019-06-28 10:18 評論0 收藏0
使用 Hexo 創建項目文檔網站

摘要：而且通常來說，是用來介紹項目，而不是展示文檔。如果不確定系統中是否已經安裝了，使用下面的命令檢查如果出現了的版本號，則不需要再安裝了。例如我執行的命令如下然后使用進入項目目錄，并創建一個名為的目錄目錄將存放我們的文檔。當我們發布一個開源項目的時候，最重要的事情之一就是要創建項目文檔。對使用項目的用戶來說，文檔是非常有必要的，通常我們可以使用下面這些方式來創建文檔： GitHub W...

mikasa 2019-08-01 17:05 評論0 收藏0
搭建博客太簡單，這次我們來做一個博客生成工具

摘要：代碼如下首頁的模版博客網站的基本配置菜單生成，這里不講講中的遍歷，然后生成一個數組默認按發布時間排序置頂替換五集成在編譯博客的過程中，一些操作利用會簡單快捷許多。文章較長，耐心讀下來我想你肯定會有所收獲 : ) 作為一個技術人員，見到別人那光鮮亮麗的個人博客，心里總免不了想搭建自己博客的沖動。當然，搭建博客的方式有好多種，但是大體上分這兩種：服務端數據庫例如：你可以用 Word...

chanthuang 2019-08-23 11:55 評論0 收藏0
文檔生成工具 idoc

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

ASCH 2019-08-21 10:42 評論0 收藏0