官方網站
Git 儲存庫產品說明
CodiMD 是一款專為即時協作設計的開源 Markdown 平台。它的核心價值在於解決了傳統 Markdown 檔案在團隊間傳遞、版本不一的痛點。透過 CodiMD，多位使用者可以同時開啟同一個網址，即時編輯內容並同步看到他人的修改，這讓技術討論、會議記錄或專案規格書的產出效率極大化。
它支援所有標準的 Markdown 語法，並擴展了諸如數學公式（MathJax）、圖表（Mermaid, Graphviz）以及簡報模式（Slide Mode）。你可以將一份 Markdown 文件一鍵轉換為像 Reveal.js 那樣的精美投影片。此外，它提供完整的權限管理，你可以設定文件為私有、限特定人編輯或完全公開。
核心特色：
- 極致即時同步：毫秒級的延遲，支援數十人同時在線編輯同一份文件。
- 多功能顯示模式：支援「純編輯」、「純預覽」與「左右對照」模式，並具備自動捲動同步。
- 豐富的圖表擴展：內建對流程圖、序列圖、甘特圖與樂譜（ABC notation）的渲染支援。
- 權限管理系統：支援多種登入方式（GitHub, LDAP, Dropbox），並可精細控管文件的讀寫權限。
常用指令
CodiMD (HedgeDoc) 推薦使用 Docker Compose 進行快速部署，以確保環境一致性。
啟動與基礎操作
# 下載官方 docker-compose 配置
wget [https://raw.githubusercontent.com/hedgedoc/container/master/docker-compose.yml](https://raw.githubusercontent.com/hedgedoc/container/master/docker-compose.yml)
# 啟動 CodiMD 與 PostgreSQL 資料庫
docker-compose up -d
# 查看容器運行狀態
docker-compose ps
# 備份資料庫（以 PostgreSQL 為例）
docker-compose exec db pg_dump -U hedgedoc hedgedoc > backup.sql
| 功能模組 | 快速鍵 / 操作 | 說明 |
|---|---|---|
| 簡報模式 | 在 YAML 加入 type: slide | 將 Markdown 轉化為互動式投影片 |
| 權限設定 | 點擊右上角「Share」 | 設定為 Freely, Editable, Limited 或 Locked |
| 版本歷史 | 點擊「History」圖示 | 查看並恢復過往的編輯版本 |
| 匯出檔案 | 選單「Download」 | 支援匯出為 .md, .html 或 .pdf |
進階技巧
簡報轉場自定義：在 Markdown 的頭部 YAML 區塊中，可以定義
transition,theme等參數，直接控制簡報的視覺效果。整合外部圖片床：透過環境變數設定，可以將上傳的圖片自動儲存至 S3 或 MinIO，避免佔用伺服器本機空間。
利用 Webhook 通知：結合自動化工具，當重要文件被修改時，自動向 Slack 或 Discord 頻道發送更新通知。
操作介面
