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
2.1 Home page
# 2.1 Home Page The home page of `MrDoc` is the list page of projects.  The home page of `MrDoc` mainly consists of the following parts: - Header: contains the `MrDoc` logo, the search box for projects, the button for creating a new document, and the user-related hover list; - Main body: contains the list of projects that the current user (guest not logged in or logged-in user) has permission to view, and the pagination bar of the project list; - Footer: contains the copyright notice of `MrDoc`; ## Header ### Project Search `MrDoc` provides a search box in the header of the home page for searching projects. The search scope includes the projects that the current user has permission to view, and the search term will match the title and description of the projects. If there are search results, they will be displayed, as shown in the figure below:  If there are no results matching the search criteria, `MrDoc` will give you a prompt as shown in the figure below:  ### New Document Button On the home page, we provide a convenient link for writing documents, allowing users to quickly enter the document editing page. If the user is already logged in, clicking the "New Document" link in the header will open the document editing page in a new tab. If the user is not logged in, clicking the "New Document" link in the header will open the user login page in a new tab. ### User-related Hover Button List On the far right of the home page header, there are several user-related hover buttons, which are marked with a black half-body person icon regardless of whether the user is logged in or not. If the user is already logged in, hovering the mouse here will display: - Admin management; (if the user is the site administrator of `MrDoc`) - Personal center; - Change password - Log out; Clicking the button links will enter the corresponding pages and invoke the corresponding functions.  Conversely, if the user is not logged in, hovering the mouse here will display: - Log in - Register Two button links, clicking them will jump to the login page and registration page respectively. ## Main Body ### Project List The project list on the home page is arranged in the form of 3 per row on the PC side and 1 per row on the mobile side when the number of projects is sufficient. Each project block displays the following information about the project: - The name of the project; - The creator of the project - The name of the most recently edited document in the project; - The description of the project; If the project name, the name of the most recently edited document in the project, and the project description exceed the length, they will be omitted in the form of `……`; when the mouse stays on the corresponding data, the complete content will be displayed, as shown in the figure below:  ### Project Pagination The project list on the home page displays a maximum of 12 projects per page, and projects beyond that need to be displayed through pagination.
mrdoc
Sept. 29, 2026, 6:37 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)