MrDoc User Guide
Basic concepts
MrDoc page description
2.1 Home page
2.2 Collection browsing page
2.3 Document browsing page
2.4 Document editing and modification
2.4.1 Creating a document
2.4.2 Modify document
2.4.3 Create document template
2.4.4 Modify document template
2.4.5 Brief introduction to Markdown syntax
2.4.7 Uploading attachments
2.4.8 Draw a mind map
2.5, Personal Center
2.5.1 Managing documents
2.5.2 Managing collections
2.5.3 Managing document templates
2.5.4 Managing images
2.5.5 Managing user tokens
2.7 Registration and login
2.7.1 User registration
2.7.2 User login
Getting started
Create collection
Create document
Add member collaboration
Documents and knowledge base basics
Collection basic configuration
Pin collection
WebHook message push
Hide collection on homepage
Collection association set
Collection tab configuration
Document editing and content creation
Add document attachments
Show document directory
Create document shortcut
Set document tags
Set document alias
Insert video
Automatic document saving
Document management and organization
Collection directory sorting
Modify document sorting
Subordinate document control
Set document parent-child
Document version history
Transfer collection
Transfer document
Copy document/Move document
Document access records
Collection export and download
Document download and export
Export document PDF
Document drag-and-drop sorting
Collaboration and permission management
Set document permissions
Set collection access permissions
Document copy protection
Set document watermark
Collection collaboration/Collection member management
Document sharing
Collection sharing
Enable document comments
Image and attachment management
Configure image/attachment upload size limit
Configure image upload formats
Configure attachment upload formats/attachment allowlist
Attachment preview
Transfer attachments/Transfer images
Clean up images
Extract attachment text in bulk with the manage command
Data import and migration
Desktop client import
Import Joplin notebooks
Import Evernote
Web import
Command-line import
Web export
Third-party login configuration
DingTalk QR code login and in-app passwordless login configuration
WeCom authentication integration
LDAP authentication integration configuration
OIDC authentication integration
WeChat Official Account web authorization
Third-party storage configuration
MinIO configuration
Qiniu Cloud OSS configuration
Alibaba Cloud OSS configuration
AWS S3 configuration
AI knowledge base and intelligent Q&A
Basic configuration
AI model configuration
Qdrant deployment
Dify framework configuration
Rebuild document AI index
AI features
AI document creation
AI knowledge base Q&A
AI Q&A bot
WeCom smart robot
OnlyOffice integration
Drawio integration
System settings and management
Site information configuration
Homepage template configuration
Official website theme homepage configuration instructions
User and account configuration
Statistics code configuration
Document ads/info blocks/custom head configuration
Disable update detection
Site-wide search mode
Display image thumbnails in documents
Site feedback
RSS subscription
Site single tag settings
Outbound email configuration
Site data export
Editor configuration
Collection documentation page displays site top navigation bar.
Site announcement configuration
Personal account management
Set default editor
Set user nickname
Modify user password
Bind a third-party account
API and developer interfaces
Get user token
Get collection list
Get collection directory
Get collection document list
Get personal document list
Get specified document content
Create new collection
Create a new document
Update documentation
Upload image
Upload attachments
Verify user token
Upload local Office/PDF files as documents
Client and ecosystem integration
Desktop client
Mobile client
Browser extensions
Obsidian plugins
Common usage issues index
Powered by MrDoc Pro
-
+
home
Basic configuration
# Basic Configuration ## Basic Configuration ### Status Used to control the enabled status of the AI integration feature. It is disabled by default. Once enabled, MrDoc will enable the corresponding AI capabilities based on the currently configured AI framework and related parameters, including chat dialogue, AI-assisted writing, knowledge base search, and other features. ### AI Framework Used to select the large language model (LLM) framework that MrDoc integrates with. The current AI ecosystem is developing rapidly, and different frameworks have their own characteristics in terms of features, deployment methods, and extensibility. You can choose a suitable AI framework based on your own needs and usage habits. >i Note: >i After selecting an AI framework, you also need to complete the relevant parameter configuration in the corresponding configuration tab, otherwise the AI features will not work properly. The following AI frameworks are currently supported: * Built-in Engine * Dify * * * #### Built-in Engine The built-in engine is the default AI solution provided by MrDoc. Its features include: * Document vectorization, retrieval, question answering, and other capabilities are all completed within MrDoc; * Various AI processing tasks fully conform to MrDoc's native permissions; * No additional vector database deployment is required by default; * Supports out-of-the-box use, suitable for rapid deployment; * Optionally supports integrating Qdrant as an external vector database to improve vector retrieval capability and scalability. Suitable for: * Users who want to quickly enable AI features; * Small and medium-scale knowledge base scenarios; * Scenarios where deployment and maintenance complexity should be reduced. * * * #### Dify Dify is a popular AI workflow and application orchestration platform. MrDoc supports integration with Dify, enabling: * Synchronizing documents to the Dify knowledge base; * Calling Dify's AI applications and workflows; * Using the chat and question answering capabilities provided by Dify; * Unified management of multiple large language model services. Suitable for: * Users who have already deployed Dify; * Scenarios requiring complex AI workflows; * Scenarios where unified management of multiple models and AI applications is desired. For detailed configuration instructions, please refer to: https://doc.mrdoc.pro/doc/45683/ ## Chat Dialog Box > i Requires configuring the AI framework's "Chat API Key" Once enabled, an AI chat dialog box will be displayed on the MrDoc homepage, allowing users to chat directly with the large language model. You can set the visibility scope and usage permissions of the chat dialog box according to actual needs. Applicable scenarios: * AI intelligent question answering * Document content consultation * Enterprise knowledge assistant * Internal intelligent customer service ## AI-Assisted Writing > i Requires configuring the AI framework's "Text Generation API Key" Once enabled, an "AI" dropdown menu will be added to the Editor.md editor toolbar, providing the following features: * AI document creation * AI content continuation * AI text polishing Applicable to: * Document writing * Technical writing * Content creation ## AI Knowledge Base Search Once enabled, the document search results page will additionally display intelligent question answering results from the AI knowledge base. The system will combine knowledge base content to perform semantic retrieval and AI summarization on the questions users search for, helping users obtain the information they need more quickly. Applicable to: * Enterprise knowledge bases * Product documentation centers * Technical document retrieval * FAQ intelligent question answering scenarios
mrdoc
Sept. 29, 2026, 6:41 p.m.
Forward
Favorites
Last
Next
Scan the QR Code
Copy link
Scan the QR code to share.
Copy link
share
link
type
password
Update password
Validity period
Markdown file
Word document
PDF document (print)