MarkDown 標題自動添加編號


說明

這是一個實現給本地 Markdown 文件添加標題編號的 python 腳本。可與 Markdown 文件自動生成目錄 搭配使用。

假設你現在有一個 Markdown 文件,這個文件有很多級標題且標題沒有編號,如圖:

一個一個自己添加編號很麻煩,但有這個 python 腳本就可以不用愁了。

使用

  1. 首先,你需要安裝好 python 解釋器並配置好了環境變量。網上有很多教程,這里就不作介紹了。

  2. 然后,你需要將該 python 腳本與 Markdown 文件復制到同一個目錄下(注意該目錄要有寫入權限,如果后面運行程序時報錯顯示沒有寫入權限);

  3. 接下來,你可以選擇直接雙擊腳本開始運行(需要系統默認為用 python 解釋器打開 .py 文件),或者通過 powershell、cmd、git 之類的命令行工具輸入命令運行,下面以 powershell 為例演示:

在該文件夾下按住 shift 鍵並右擊鼠標,在菜單中點擊 在此處打開powershell窗口(如果你希望使用 cmd 運行,在 py 文件所在文件夾的路徑欄里輸入 cmd 然后回車即可 #1樓),如圖:

因為我的 Markdown 文件文件名和 python 源文件名分別為 README.mdtitle_number.py,所以在進入 powershell 后,輸入 python title_number.py README.md 並按回車:

這時候會發現 powershell 中顯示 文件已生成 ,這說明文件生成成功了。回到文件夾下會發現新生成了一個文件:

這就是已經給標題編號了的 Markdown 文件,如圖:

補充

  1. 雖然程序具備處理特殊情況的能力,但為了盡可能避免特殊情況,建議使用時將 Markdown 文件中的標題分級、規范地寫好。如果出現編號出錯,請檢查 Markdown 標題是否規范。如檢查標題后確定沒問題,可以到 GitHub 提 issue 或者直接在這里回復。

  2. 如果你的文件名包含空格,如 Getting start Java.md,那么,你需要在輸入命令時用引號將其括住,即輸入 python AddTitleNumber.py 'Getting start Java.md'。如果遇到了其他正確輸入文件名但提示 未找到文件 的情況,可以嘗試將文件重命名,如命名為 'readme.md',或者直接雙擊腳本運行。

  3. 現在一個已知的問題是程序可能會受到 python 行注釋符號 # 的干擾而無法正常運行,后期可能會完善。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM