CodiMD 介紹
CodiMD 是一個開源的實時協作 Markdown 筆記工具，它允許用戶在任何平臺上共同編輯 Markdown 文檔。核心功能是實時協作，它允許多個用戶同時編輯同一個文檔，并實時看到彼此的更改。支持實時渲染預覽，支持超多的富文本格式，比如常用的圖片、表格、emoji 表情和代碼段，此外還有各種圖表和數學公式。
🚢 項目地址
- Github：https://github.com/hackmdio/codimd
- 官網: https://hackmd.io/
🚀CodiMD 特征
-
🚀 開源且自由：CodiMD 完全開源，您可以自由地在私有服務器上部署，完全掌控您的數據。
-
? 強大的 Markdown 支持：它對 Markdown 語法有出色的支持，各種流程圖，并且可以實時預覽編輯的效果。
-
🔌 高度自定義：除了基本的編輯功能，CodiMD 還提供了 API 和插件支持，允許開發者進行進一步的擴展和定制。
-
👤 實時協作：多人可以在同一份文檔上進行實時編輯，且每個人的編輯都會有不同的顏色標記，方便追蹤。
-
🌐良好的兼容性：兼容主要瀏覽器，包括 Chrome、Safari 和 Firefox 等，使用戶在不同的設備和操作系統上均可獲得流暢體驗
-
🔑獨立自主的存儲解決方案: 與大多數依賴于云端存儲的工具不同，CodiMD 允許用戶自主管控所有數據。通過選擇適合的托管解決方案，用戶可根據需求設計專屬的安全性與隱私策略。
🛠? 部署 CodiMD
👻 先決條件/要求
- 最低 512MB RAM（推薦 1GB+）
- 具備docker，docker-compose 環境
🐳 使用Docker Compose部署
version: "3"
services:database:#image: postgres:11.6-alpineimage: docker.cnb.cool/srebro/pidin/postgres:11.6-alpine ##CNB鏡像加速地址environment:- POSTGRES_USER=codimd- POSTGRES_PASSWORD=pidin.srebro.cn ##自定義密碼- POSTGRES_DB=codimdvolumes:- "database-data:/var/lib/postgresql/data"restart: alwayscodimd:#image: nabo.codimd.dev/hackmdio/hackmd:2.5.4image: docker.cnb.cool/srebro/pidin/hackmd:2.5.4 ##CNB鏡像加速地址environment:- CMD_DB_URL=postgres://codimd:pidin.srebro.cn@database/codimd- CMD_USECDN=falsedepends_on:- databaseports:- "3000:3000"volumes:- upload-data:/home/hackmd/app/public/uploadsrestart: always
volumes:database-data: {}upload-data: {}
瀏覽器訪問CodiMD 地址：http://ip:3000/
🧭 使用Nginx反向代理
#CodiMDserver {listen 443 ssl;server_name codimp.srebro.cn; ##替換成自己的域名error_page 404 /404/404.html;charset utf-8;ssl_certificate /home/application/nginx/cert/srebro.cn.pem; ssl_certificate_key /home/application/nginx/cert/srebro.cn.key;ssl_session_cache shared:SSL:1m;ssl_ciphers HIGH:!aNULL:!MD5;ssl_prefer_server_ciphers on;location / {proxy_http_version 1.1;proxy_set_header Upgrade $http_upgrade;proxy_set_header Connection "upgrade";proxy_set_header X-Real-IP $remote_addr;proxy_set_header x-wiz-real-ip $remote_addr;proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;proxy_set_header Host $http_host;proxy_set_header X-Forwarded-Proto $scheme;proxy_pass http://localhost:3000;}
}
-
注冊賬戶
? 注意： 這里注冊 和 登錄都是同一個輸入框，需要先填入郵箱和密碼，然后點擊注冊，即可
- 登錄后界面
- 新建筆記
- 導入一個Markdown 文件
- 可以實時看到markdown源代碼和渲染后的界面
- 右上角顯示 一個用戶 在線，也就是當前用戶；
- 實時協作
- 新打開一個無痕的瀏覽器窗口，復制上面的URL地址，可以看到右上角多了一個參與者，在線人數變成了2人
- ? 如果需要一起協助編譯，需要再創建一個用戶并且登錄上，默認顯示是Guest訪客
🎁 獲取CodiMD
- CNB 倉庫地址：CodiMD
