Skip to content

Commit ba671fe

Browse files
committed
docs: update README.
1 parent 5905421 commit ba671fe

2 files changed

Lines changed: 14 additions & 8 deletions

File tree

README.en.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ All your data = one `data/just-wiki.db` SQLite file + the `media/` folder. Backu
2828
## Features
2929

3030
**Editing & content**
31-
- **Markdown first** — Milkdown WYSIWYG editor with slash commands, Mermaid diagrams, KaTeX math, callout blocks
31+
- **Markdown-first WYSIWYG** — Milkdown lets non-technical users write naturally, while the storage stays plain Markdown so engineers can pipe it through Git or scripts; you're never locked into a proprietary format
32+
- **Slash commands & rich blocks** — Mermaid diagrams, KaTeX math, callout blocks
3233
- **Wikilinks**`[[page]]` syntax with automatic backlink tracking
3334
- **Page hierarchy & templates** — nested page trees, one-click reusable templates
3435
- **Draw.io integration** — embedded diagram editor
@@ -56,10 +57,12 @@ All your data = one `data/just-wiki.db` SQLite file + the `media/` folder. Backu
5657
</p>
5758

5859
**Collaboration & permissions**
59-
- **Multi-user + group ACL** — per-page permission control
60-
- **Version history** — page revisions with diff view
60+
- **Multi-user + group ACL** — per-page permission control (inherited from parent pages)
61+
- **Concurrent-edit safety** — optimistic locking (`base_version`) so simultaneous edits never silently clobber each other
62+
- **Version history** — page revisions with diff view; roll back when something gets broken
6163
- **Comments, bookmarks, tags, page subscriptions** — everything a small team needs
62-
- **Activity log & trash** — see recent changes, recover deleted pages
64+
- **Activity log & trash** — see recent changes; deletions are soft and recoverable
65+
- **SSO & API tokens** — built-in OIDC (Google, GitHub, custom), LDAP, and personal Bearer tokens for enterprise SSO and automation scripts
6366

6467
**Export & deployment**
6568
- **Flexible export** — per-page Markdown / HTML / PDF (browser print), full-site static zip

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
## 功能特色
2525

2626
**編輯與內容**
27-
- **Markdown 優先** — Milkdown 所見即所得編輯器,支援 slash commands、Mermaid 流程圖、KaTeX 數學公式、Callout 提示框
27+
- **Markdown 優先、所見即所得** — Milkdown 編輯器讓非工程師直接寫,但底層儲存仍是純 Markdown,工程師能用 Git/腳本處理、備份不被綁定在自家格式
28+
- **Slash 指令與多種區塊** — Mermaid 流程圖、KaTeX 數學公式、Callout 提示框
2829
- **Wikilinks**`[[頁面]]` 語法快速連結,自動追蹤反向連結(backlinks)
2930
- **頁面階層與範本** — 巢狀頁面結構、常用範本一鍵套用
3031
- **Draw.io 整合** — 內建圖表編輯器
@@ -52,10 +53,12 @@
5253
</p>
5354

5455
**協作與權限**
55-
- **多使用者 + 群組 ACL** — 頁面層級的權限控制
56-
- **版本歷史** — 每頁修訂紀錄與差異比對
56+
- **多使用者 + 群組 ACL** — 頁面層級的權限控制(權限由父頁面繼承)
57+
- **併發編輯保護** — 樂觀鎖機制(`base_version`),多人同時編輯不會默默互蓋
58+
- **版本歷史** — 每頁修訂紀錄與差異比對,改壞了能回滾
5759
- **留言、書籤、標籤、頁面訂閱** — 小團隊協作夠用
58-
- **活動紀錄與垃圾桶** — 近況一目了然、刪除可救回
60+
- **活動紀錄與垃圾桶** — 近況一目了然、刪除採軟刪除可救回
61+
- **SSO 與 API Token** — 內建 OIDC(Google、GitHub、自訂)、LDAP、個人 Bearer Token,可整合企業帳號系統與自動化腳本
5962

6063
**匯出與部署**
6164
- **多格式匯出** — 單頁匯出為 Markdown / HTML / PDF(瀏覽器列印),整站打包為靜態 zip

0 commit comments

Comments
 (0)