Markdown 轉 HTML 網站產生器
將 Markdown 文件轉換為互動式 HTML 網站,支援離線瀏覽。
什麼是這個工具?
這個工具可以將一個資料夾中的 Markdown 檔案,自動轉換成一個完整的靜態網站。
主要特色
| 功能 | 說明 |
|---|---|
| 離線可用 | 所有檔案使用相對路徑,可複製到 USB 發放 |
| 全站搜尋 | 即時搜尋所有文件內容 |
| 深色模式 | 支援深色/淺色主題切換 |
| 筆記功能 | 可在段落旁邊添加個人筆記 |
適用場景
這個工具特別適合以下情境:
- 企業教育訓練
- 將訓練教材轉成可離線瀏覽的網頁
- 不需要 IT 支援,用 USB 就能發放
- 技術文件
- 產品使用手冊
- API 文件
- SOP 流程文件
- 知識庫
- 部門知識庫
- 專案文件整理
快速開始
# 基本使用
python md_to_html_site.py "來源資料夾" --title "網站標題"
# 完整參數
python md_to_html_site.py "來源資料夾" \
--title "我的文件網站" \
--description "這是一個測試網站" \
--depth 2
提示:執行後會自動開啟產生的首頁
系統需求
- Python 3.8 以上
- Pandoc(Markdown 轉 HTML 的核心工具)
安裝 Pandoc
Windows 使用者可以用 Chocolatey 安裝:
choco install pandoc
或從官網下載:https://pandoc.org/installing.html