Skip to content

Commit 4b051ef

Browse files
PhilipinhoPhilipinho
committed
update docs
1 parent 1a94c39 commit 4b051ef

File tree

9 files changed

+324
-15
lines changed

9 files changed

+324
-15
lines changed

docs/user-guide/license-and-editions.md renamed to docs/self-hosting/license-and-editions.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
sidebar_position: 16
3+
slug: /editions
34
---
45

56
# License & Editions
67

78
Docmost is available in two editions for self-hosted deployments: **Open Source** and **Enterprise**.
9+
They both allow self-hosting and on-premises deployment.
810

911
## Editions
1012

@@ -15,14 +17,15 @@ The open source edition is free to use and includes all core documentation and c
1517
### Enterprise
1618

1719
The enterprise edition includes everything in the open source edition, plus additional features designed for larger teams and organizations.
20+
You need an enterprise license key to unlock enterprise features.
1821

1922
## Feature Comparison
2023

2124
| Feature | Open Source | Enterprise |
2225
|---------|:----------:|:----------:|
2326
| Pages, editor and rich content blocks | ✅ | ✅ |
2427
| Spaces and permissions | ✅ | ✅ |
25-
| Page level permissions | ❌ | ✅ |
28+
| Page-level permissions | ❌ | ✅ |
2629
| Groups | ✅ | ✅ |
2730
| Page history and restore | ✅ | ✅ |
2831
| Comments | ✅ | ✅ |
@@ -37,11 +40,9 @@ The enterprise edition includes everything in the open source edition, plus addi
3740
| Full-text search in pages | ✅ | ✅ |
3841
| Full-text search in attachments (PDF, DOCX) | ❌ | ✅ |
3942
| AI | ❌ | ✅ |
40-
| MCP | ❌ | ✅ |
4143
| SSO (SAML, OIDC, LDAP) | ❌ | ✅ |
4244
| Multi-factor authentication (MFA) | ❌ | ✅ |
4345
| API management | ❌ | ✅ |
44-
| Audit logs | ❌ | ✅ |
4546
| Priority support | ❌ | ✅ |
4647

4748
## Activating an Enterprise License

‎docs/user-guide/ai.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
sidebar_position: 12
3+
tags:
4+
- enterprise
35
---
46

57
# AI

‎docs/user-guide/api.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
sidebar_position: 13
3+
tags:
4+
- enterprise
35
---
46

57
# API

‎docs/user-guide/editor.md‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 7
44

55
# Editor
66

7-
Docmost features a block-based rich text editor built on top of TipTap. The editor supports a wide range of content types, formatting options, and embeds to help you create rich documentation.
7+
Docmost features an advanced WYSIWYG rich text editor. The editor supports a wide range of content types, formatting options, and embeds to help you create rich documentation.
88

99
## Slash Commands
1010

@@ -43,17 +43,16 @@ Type `/` on a new line to open the slash command menu. You can also type to filt
4343

4444
### Advanced
4545

46-
| Command | Description |
47-
|---------|-------------|
48-
| **Math inline** | Insert an inline math equation (KaTeX) |
49-
| **Math block** | Insert a block-level math equation (KaTeX) |
46+
| Command | Description |
47+
|---------------------|----------------------------------------------------------------|
48+
| **Math inline** | Insert an inline math equation (KaTeX) |
49+
| **Math block** | Insert a block-level math equation (KaTeX) |
5050
| **Mermaid diagram** | Insert a Mermaid diagram (flowcharts, sequence diagrams, etc.) |
51-
| **Draw.io** | Open the Draw.io diagram editor |
52-
| **Excalidraw** | Open the Excalidraw whiteboard editor |
53-
| **Date** | Insert a date with a calendar picker |
54-
| **Subpages** | List all child pages of the current page |
55-
| **Insert Link** | Link to pages or external URLs |
56-
| **Mention member** | Mention a workspace member |
51+
| **Draw.io** | Open the Draw.io diagram editor |
52+
| **Excalidraw** | Open the Excalidraw whiteboard editor |
53+
| **Date** | Insert a date with a calendar picker |
54+
| **Subpages** | List all child pages of the current page |
55+
| **Status** | Display a custom status badge in the page. | |
5756

5857
### Embeds
5958

@@ -110,6 +109,10 @@ The editor supports three diagram tools that you can insert via the `/` slash co
110109

111110
For more details, see the [Diagrams](./diagrams) page.
112111

112+
## Anchors
113+
114+
You can copy page anchors in headings to quickly link to specific sections. Simply hover over a heading to reveal the anchor icon, then click to copy the link.
115+
113116
## Tables
114117

115118
To insert a table, type `/` and select **Table**. A 3×3 table is inserted with a header row enabled by default.

‎docs/user-guide/mcp.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
sidebar_position: 14
3+
tags:
4+
- enterprise
5+
---
6+
7+
# MCP
8+
9+
Docmost provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that allows AI assistants and tools to interact with your workspace content. Through MCP, AI clients can search, read, create, and update pages, manage spaces, and more — all using your existing API key for authentication.
10+
11+
:::note
12+
MCP is an enterprise feature. An active enterprise license is required.
13+
:::
14+
15+
## Enabling MCP (Admin)
16+
17+
MCP must be enabled by a workspace admin before it can be used.
18+
19+
1. Go to **Settings** > **AI & MCP**.
20+
2. Click the **MCP** tab.
21+
3. Toggle the MCP switch on.
22+
4. The **MCP Server URL** is displayed. It follows the format: `https://YOUR_DOCMOST_URL.com/api/mcp`.
23+
24+
Once enabled, any workspace member with an API key can connect their AI tools to the MCP server.
25+
26+
## Authentication
27+
28+
MCP uses your personal API key for authentication. To create an API key:
29+
30+
1. Go to **Settings** > **API keys** (under Account).
31+
2. Click **Create API Key**.
32+
3. Copy the key and store it securely — it cannot be viewed again.
33+
34+
The API key is passed as a Bearer token in the Authorization header. Your MCP client will handle this automatically once configured.
35+
36+
## Connecting AI Clients
37+
38+
### Claude Desktop
39+
40+
Add the following to your Claude Desktop configuration file (`claude_desktop_config.json`):
41+
42+
```json
43+
{
44+
"mcpServers": {
45+
"docmost": {
46+
"command": "npx",
47+
"args": [
48+
"-y",
49+
"mcp-remote",
50+
"https://YOUR_DOCMOST_URL.com/api/mcp",
51+
"--header",
52+
"Authorization: Bearer YOUR_API_KEY"
53+
]
54+
}
55+
}
56+
}
57+
```
58+
59+
Replace `https://YOUR_DOCMOST_URL.com` with your Docmost instance URL and `YOUR_API_KEY` with your API key.
60+
61+
### Claude Code
62+
63+
Run one of the following commands to add the Docmost MCP server:
64+
65+
```bash
66+
claude mcp add --transport http --header "Authorization: Bearer YOUR_API_KEY" docmost https://YOUR_DOCMOST_URL.com/api/mcp
67+
```
68+
69+
Or using `mcp-remote`:
70+
71+
```bash
72+
claude mcp add docmost -- npx -y mcp-remote https://YOUR_DOCMOST_URL.com/api/mcp --header "Authorization: Bearer YOUR_API_KEY"
73+
```
74+
75+
### Cursor
76+
77+
Add the following to your Cursor MCP configuration (`.cursor/mcp.json`):
78+
79+
```json
80+
{
81+
"mcpServers": {
82+
"docmost": {
83+
"command": "npx",
84+
"args": [
85+
"-y",
86+
"mcp-remote",
87+
"https://YOUR_DOCMOST_URL.com/api/mcp",
88+
"--header",
89+
"Authorization: Bearer YOUR_API_KEY"
90+
]
91+
}
92+
}
93+
}
94+
```
95+
96+
## Supported Tools
97+
98+
The MCP server exposes the following tools:
99+
100+
### Pages
101+
102+
| Tool | Description |
103+
|------|-------------|
104+
| **search_pages** | Search for pages by keyword |
105+
| **get_page** | Get the content of a specific page |
106+
| **create_page** | Create a new page in a space |
107+
| **update_page** | Update an existing page's title or content |
108+
| **list_pages** | List recent pages in a space |
109+
| **list_child_pages** | List child pages of a specific page |
110+
| **duplicate_page** | Duplicate a page within its space |
111+
| **copy_page_to_space** | Copy a page to a different space |
112+
| **move_page** | Move a page to a different position or parent |
113+
| **move_page_to_space** | Move a page to a different space |
114+
115+
### Spaces
116+
117+
| Tool | Description |
118+
|------|-------------|
119+
| **get_space** | Get details of a specific space |
120+
| **list_spaces** | List all spaces you have access to |
121+
| **create_space** | Create a new space |
122+
| **update_space** | Update a space's name or description |
123+
124+
### Comments
125+
126+
| Tool | Description |
127+
|------|-------------|
128+
| **get_comments** | Get comments on a page |
129+
| **create_comment** | Add a comment to a page |
130+
| **update_comment** | Update an existing comment |
131+
132+
### Other
133+
134+
| Tool | Description |
135+
|------|-------------|
136+
| **search_attachments** | Search for file attachments across the workspace |
137+
| **list_workspace_members** | List members of the workspace |
138+
| **get_current_user** | Get details of the authenticated user |
139+
140+
## Permissions
141+
142+
MCP respects the same permissions as the Docmost web application. The connected user can only access spaces and pages they have permission to view or edit. Actions like creating or updating pages require the appropriate write permissions.

‎docs/user-guide/pages/_category_.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Pages",
3+
"position": 8,
4+
"collapsed": true
5+
}

docs/user-guide/pages.md renamed to docs/user-guide/pages/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 1
33
---
44

55
# Pages

0 commit comments

Comments
 (0)