使用教學

一步步教你如何使用這個工具。


第一步:準備 Markdown 檔案

將你的 Markdown 檔案整理成資料夾結構:

我的文件/
├── 01_入門/
│   ├── 簡介.md
│   └── 安裝.md
├── 02_進階/
│   ├── 設定.md
│   └── 客製化.md
└── README.md

Markdown 撰寫建議

  1. 使用 # 作為文件標題
    • 工具會自動抓取第一個 # 作為文件標題
  2. 善用標題層級
    • ##### 會自動產生側邊目錄
  3. 表格和程式碼區塊
    • 完整支援 GitHub Flavored Markdown

第二步:執行轉換

打開終端機,執行:

python md_to_html_site.py "C:\我的文件" --title "我的知識庫"

輸出結果

執行後會產生兩個資料夾:

資料夾 說明
html_output/ 輕量版(不含影片)
html_output_video/ 影片版(含嵌入影片)

第三步:瀏覽與分享

本機瀏覽

直接用瀏覽器開啟 index.html 即可。

分享給他人

將整個 html_output 資料夾壓縮後分享:


常見問題

Q: 為什麼搜尋功能在本機可以用?

A: 我們將搜尋索引直接嵌入 HTML 中,避免了 file:// 協議的 CORS 限制。

Q: 可以客製化樣式嗎?

A: 目前樣式是嵌入在 Python 腳本中,未來會支援外部 CSS 檔案。

Q: 支援哪些影片格式?

A: 目前支援 MP4 格式。將 .mp4 檔案放在與 .md 同一資料夾即可。

0:00 / 0:00

📝 筆記

❓ 使用說明

🔍 搜尋功能

  • 點擊搜尋框或按 Ctrl+K 快速搜尋
  • 搜尋結果會高亮顯示關鍵字

📝 筆記功能

  • 🌐 網站筆記:記錄整體心得(全站共用)
  • 📄 文件筆記:記錄單篇文件重點
  • 📝 段落筆記:在段落旁點擊 📝 記錄

💾 筆記儲存

  • 自動儲存於瀏覽器(換電腦會遺失)
  • 建議定期點擊「匯出筆記」備份

🎨 其他功能

  • 🌙 深色模式:右上角切換
  • 🔤 字體大小:A- / A+ 調整
  • 📺 影片子母畫面:滾動時自動懸浮

📤 匯出筆記

選擇要匯出的筆記範圍:

(0 則)
(0 則)
(0 則)

匯出格式:

📚 筆記中心