將 Markdown 檔案轉換為 HTML,內建超過十多種主題。
功能
- 包含 15+ 種現成的 Markdown CSS 樣式表,請查看 readme 底部以獲取螢幕截圖。
- 重複使用這些樣式表,或使用
generate-md
工具,將 Markdown 檔案夾轉換為 HTML,並使用其中一種內建的版面配置或自訂版面配置。
- 完全靜態的輸出,易於託管在任何地方。
- 中繼資料支援:每個檔案都可以在標頭部分包含額外的中繼資料,例如頁面標題和作者姓名,然後可在版面配置中使用。
版面配置功能
- 內建支援透過 highlight.js 進行程式碼語法突顯;所有版面配置預設都包含 Github 風格的程式碼突顯主題。
- 從 Markdown 標題內建產生目錄,可透過替換自訂版面配置中的
{{> toc}}
部分來完全自訂。
- 為 Markdown 中撰寫的標題內建標頭 ID 和錨點產生;所有版面配置都支援透過標頭懸停連結顯示 URL。
- 支援透過
--highlight-*
自訂邏輯來呈現程式碼區塊;這可以用於實作自訂區塊,以有趣的呈現方式呈現程式碼區塊的內容。
- 自動從 Markdown 標記中的第一個標題偵測文件標題。
- 透過
--layout
基於現有版面配置建立自己的版面配置,並具有
- 完全支援 Handlebars 版面配置、輔助程式和部分
- 可透過
toc
部分完全自訂的目錄範本
- 支援透過
{{asset 'path'}}
輔助程式產生相對路徑