Toggle

重新回歸簡(jiǎn)書(shū),目前仍在使用的

  1. 博客: http://skyrover.me
  2. Github: https://github.com/Microndgt

Toggle是一個(gè)給markdown文件或者數(shù)據(jù)加目錄的小工具,點(diǎn)擊目錄項(xiàng)就可以跳轉(zhuǎn)到相應(yīng)章節(jié),簡(jiǎn)書(shū)貌似不支持markdown錨點(diǎn),Github上的md文件預(yù)覽是可以的,比如https://github.com/Microndgt/toggle

已經(jīng)發(fā)布在Github上了toggle in GitHub,歡迎star和修正。

toggle

generate and update markdown table of contents on the top of md file

Usage

QuickStart

t = Toggle(filename="path/to/file", url_prefix="content/url/prefix")
# 生成目錄
t.generate()  # return contents of md
# 更新目錄
t.update()  # return contents of md

arguments of Toggle

  • url_prefix: 該md顯示網(wǎng)頁(yè)的url
  • filename: 輸入為文件路徑
  • content: 輸入為文件內(nèi)容數(shù)據(jù),list,每一項(xiàng)為文件數(shù)據(jù)的一行,若同時(shí)輸入文件名和文件數(shù)據(jù),以文件數(shù)據(jù)優(yōu)先
  • match_rules: 匹配規(guī)則,dict,默認(rèn)匹配 === 和 ---,值為該匹配項(xiàng)對(duì)應(yīng)生成的md目錄行的前綴,如===對(duì)應(yīng)-
  • sub_rules: 替換規(guī)則,dict以替換標(biāo)題項(xiàng)中的字符,使得符合markdown解析規(guī)則,比如替換'.'為''

Author

SkyRover

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀(guān)點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容