/README-ToC-Generator

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

Donkey Bear's README ToC Generator

這是一個簡單的 Python 小程式,用於偵測 README.md 內的各級標題,並以其為依據生成文章目錄(ToC, Table of Contents)。

目錄

前言

此專案起源於我的第一個練習專案(Donkey Bear's Python Exercising),由於該專案是用以整理各種練習用的程式,所以幾乎每個檔案都是一個單獨的小程式,又因為我希望能夠將這些練習用的程式當作範例,給未來的自己能在學習時供作參考,於是在其 README 內簡述了每個程式的功能,又因為手動編輯目錄的過程要一一插入錨點過於麻煩,於是寫了一個自動將標題轉換為錨點的程式

但是我仔細想了想,既然都要用程式轉換錨點了,何不乾脆將手動編輯目錄的整個過程都自動化呢?於是本專案就誕生了。

另外,本專案同時也是我截至目前為止獨立編寫過的最大專案(沒錯,就這麼點大小的專案,已經是我寫過最大的專案了),即使花了很多時間,還是有很多不足之處有待改進,希望大家能多多包涵。

返回目錄

相依性

本專案使用了 Python 官方模組 os 及非官方模組 chardet

返回目錄

專案說明

簡述不同版本的各項功能。

功能相對齊全的 README 目錄產生器,可透過 Config.txt 設定目錄樣式。

精簡的 README 目錄產生器。

刪去了透過 Config.txt 設定的功能,無須導入自製模組,適合用作修改各種衍生或客製版本。

依照我的個人使用習慣客製化的版本,基本上我也都是直接使用這個版本產生 README 目錄的。

返回目錄

使用說明

將編寫好的 README.md 與目錄產生器置於同一路徑下,執行目錄產生器後即自動生成目錄 ToC.md

返回目錄

授權條款

本專案引用了 chardet 模組,故繼承其授權條款 LGPL-3.0 License

返回目錄