MrDoc Open Source Edition

## Open-Source Repository

GitHub: [https://github.com/zmister2016/MrDoc](https://github.com/zmister2016/MrDoc)

Gitee: [https://gitee.com/zmister/MrDoc](https://gitee.com/zmister/MrDoc)

## Version Update Logs

### v0.9.8 2025/12/01

* **[New]** Editor now supports Find & Replace.
* **[New]** Online spreadsheets can be downloaded as Excel files.
* **[Feat]** Long code blocks now wrap correctly when printing to PDF.
* **[Feat]** Optimized functions and APIs for fetching collection directories.
* **[Feat]** Updated collection outline style on the left sidebar to match the Pro version.
* **[Feat]** Improved layout for document sharing and tag pages.
* **[Feat]** Refined document directory styles.
* **[Feat]** Enhanced sitemap structure and URL format.
* **[Feat]** Completed English translations.

### v0.9.7 2025-09-30

*   **[Added]** Integration with the Dify AI framework and AI writing features in the Markdown editor;
*   **[Added]** Support for setting an expiration date for registration codes and optimized the admin registration code management page;
*   **[Added]** Support for configuring third-party cache databases;
*   **[Added]** Admin option to configure pages to open in a single-tab mode;
*   **[Added]** Document sharing management page in the admin panel;
*   **[Fixed]** Issue where the email verification URL required login when global login mode was enabled;
*   **[Optimized]** Login verification URL whitelist handling;
*   **[Optimized]** Support logging in using an email address as the username;
*   **[Optimized]** Homepage header display;

### v0.9.6 2025-07-02

*   **[Added]** `docker-compose.yml` file and a one-click update script based on Docker Compose;
*   **[Added]** Language configuration option to ignore browser locale and force site language;
*   **[Added]** Token verification API now returns user nickname and user type;
*   **[Added]** User Token API for retrieving project (collection) information;
*   **[Added]** User Token API for uploading attachments;
*   **[Added]** Support for the `preview` option in `config.ini`;
*   **[Fixed]** Email test header not matching some email provider protocols;
*   **[Fixed]** Editormd toolbar “insert divider” button not working;
*   **[Fixed]** Editormd not rendering on Android WebView 83, iOS 14, and other older browsers;
*   **[Fixed]** `align=right` and `align=left` attributes in Markdown image syntax not working;
*   **\[Fixed\]** `docker-update.sh` lacking execution permission in some environments;
*   **\[Optimized\]** Added default DNS configuration to `docker-compose.yml`;
*   **\[Optimized\]** User Token API list endpoint now supports filter and sort parameters;
*   **\[Optimized\]** User Token API can now retrieve documents in collaborative collections;
*   **\[Optimized\]** User Token API supports `kw` parameter for searching collections;
*   **\[Optimized\]** Storage & rendering performance of online spreadsheets;
*   **\[Optimized\]** Added default allowed CORS request headers;
*   **\[Optimized\]** Updated default uwsgi config from `http` → `http-socket`;
*   **\[Optimized\]** Upgraded code highlight library to support more languages;
*   **\[Optimized\]** Private document share links with share codes now auto-submit verification;
*   **\[Optimized\]** Convert WMF and similar image formats to PNG when importing Word files;
*   **\[Optimized\]** ECharts toolbar supports common chart templates and official example chart code;

### v0.9.5 2025-02-17

*   **\[Added\]** Export site data and media files;
*   **\[Added\]** Editormd now supports iframe syntax and setting image display ratio;
*   **\[Added\]** iframe video syntax supports setting width and height;
*   **\[Added\]** PDF download feature on document pages;
*   **\[Fixed\]** CAPTCHA image issues caused by PIL upgrade;
*   **\[Fixed\]** Rich-text editor publishing errors;
*   **\[Fixed\]** Editormd attachment upload button not responding;
*   **\[Fixed\]** Session expiration setting in config file not taking effect;
*   **\[Fixed\]** Editormd TOC indentation issue;
*   **\[Fixed\]** Homepage style issues on some mobile devices;
*   **\[Fixed\]** Pagination not switching to the page where the current document belongs;
*   **\[Optimized\]** Hide “New” menu when user is not logged in;
*   **\[Optimized\]** Rebuilt Editormd editor and Markdown renderer; unified icon style;
*   **\[Optimized\]** Updated Dockerfile;
*   **\[Optimized\]** Log output structure;
*   **\[Optimized\]** COOP policy;
*   **\[Optimized\]** Compatibility of access code verification with various collection types;
*   **\[Optimized\]** Mobile homepage header style;
*   **\[Optimized\]** Sidebar behavior for mobile collection outline;
*   **\[Optimized\]** Unsaved document prompt when closing editor;

### v0.9.4 2024-11-01

*   **\[Important Notice!!!\]**
*   Docker deployment requires upgrading the Docker image to v9.0;
*   Other deployment methods require upgrading Python to 3.11;

- **Dependency Updates**
*   Python: Base version updated to 3.11.3; minimum supported version is 3.9;
*   Django upgraded to 4.2.16;
*   PyPDF2 replaced with pypdf;
*   Selenium upgraded to 4.25.0;

- **Database Support Updates**
*   MySQL: 8.0+
*   PostgreSQL: 12+
*   MariaDB: 10.4+
*   Oracle: 19c+

- **Optimizations**
*   Collection latest-document card URL optimization;
*   Homepage collection list URL optimization;
*   404 page optimization;
*   Inline LaTeX formula font matches text font;
- **Fixes**
*   CAPTCHA URL errors in `login.html` and `register.html`;

### v0.9.3 2024-08-14

* [Added] User Token API to fetch information of a specified project;
* [Added] Project serializer now returns the project author’s nickname and the number of documents in the project;
* [Added] Configuration file now supports Session settings;
* [Added] Support for disabling attachment format validation via configuration file;
* [Added] Default site search mode configuration;
* [Added] Token QR code display in the personal center’s Token management;
* [Fixed] Pagination not resetting when scanning for unused images in the admin panel;
* [Fixed] Incorrect structure of the mrdoc.yaml file in project export package;
* [Fixed] Misaligned content blocks at the top and bottom of the document share page;
* [Fixed] Admin panel information block settings not saving correctly;
* [Fixed] Error when sending test email in email configuration;
* [Fixed] Redirect parameter vulnerability on the login page;
* [Fixed] CNVD-C-2024-34161 vulnerability;
* [Fixed] User token API not supporting JSON request body when deleting a document;
* [Optimized] Admin dashboard layout;
* [Optimized] Left main menu in admin panel and personal center;
* [Optimized] Enhanced security validation for ZIP attachment uploads;
* [Optimized] Attachment format validation logic during uploads;
* [Optimized] XSS filtering;
* [Optimized] Upgraded Vditor editor to version 3.10.4;
* [Optimized] User Token API now returns project document list with pagination;
* [Optimized] Asynchronous pagination display of large project outlines;
* [Optimized] Handling of document links in asynchronously loaded project directories;
* [Optimized] Upgraded jQuery version;
* [Optimized] Improved backend site settings options;
* [Optimized] Support for project collaborators to share documents not created by themselves;
* [Optimized] Support searching and filtering target projects when copying/moving documents;

### v0.9.2 2024-01-23

* [Added] User Token API now includes document count in the project tree data;
* [Added] User Token API for deleting documents (soft delete);
* [Added] User Token API for token validation;
* [Added] Support for configuring access to verification files (e.g., root domain verification files);
* [Added] Admin tool to scan unused images;
* [Fixed] editor.md iframe video rendering issue;
* [Fixed] Code highlight not working on document share page;
* [Optimized] User Token API POST requests now support JSON data;
* [Optimized] Updated URL whitelist for login limit;
* [Optimized] Allow CORS requests from Obsidian by default;
* [Optimized] User Token API allows setting parent document when editing a document;
* [Optimized] Forward popup style on document page;
* [Optimized] Project list page displays project description text more clearly;
* [Optimized] Added mind map example to editormd editor;
* [Optimized] Updated dependency versions;

### v0.9.1 2023-07-29

* [Optimized] Prompt users to switch to “Precise Search” when full-text search returns no results;
* [Optimized] Text prompt on search page;
* [Optimized] Documents selected as parent during move/copy can be any published document in the target project;
* [Optimized] Logic for registration and login;
* [Optimized] Enhanced URL validation for uploading images via URL;

### v0.9.0 2023-05-24

* [Fixed] Incorrect attachment URL in admin attachment management;
* [Optimized] Code highlight in Editormd preview now matches actual rendering;
* [Optimized] Registration and login pages now display the ICP record number;
* [Optimized] Email “From” header settings;
* [Optimized] Display load failure message when Markdown images cannot be loaded;

### v0.8.9 2023-04-24

* [Fixed] Issue where previous/next documents could be empty;
* [Optimized] Removed web-based project import; now handled by the local import tool;
* [Optimized] Updated URL whitelist for login restriction;
* [Optimized] Summary display of project document search results;
* [Optimized] Limited log size in uWSGI configuration file;
* [Optimized] Document search keyword highlighting logic;
* [Optimized] Search keyword parameter retained when entering a document from project-level search;
* [Optimized] Document page styling;

### v0.8.8 2023-03-15

* [Added] User Token API to get previous/next documents;
* [Added] User Token API to get personal document list;
* [Added] User Token API to get project directory;
* [Optimized] User Token API for creating documents now supports specifying parent document;
* [Optimized] Child document links now use the `/doc/xxx/` format;

### v0.8.7 2023-02-15

* [Added] Day/Night mode switching for document reading page;
* [Added] Support configuring CSRF trusted origins via configuration file;
* [Fixed] editor.md rendering English quotes as Chinese quotes;
* [Fixed] Some images failing to export when exporting projects as Markdown ZIP packages;
* [Fixed] Long code block expand feature not working;
* [Optimized] Highlight rendering logic for document search keywords;
* [Optimized] Support exporting local images in `<img>` tags when exporting a project;
* [Optimized] All documents in non-public projects can be shared by the creator;
* [Optimized] Rendering for code blocks without language specified in editor.md;
* [Optimized] Functions related to importing project ZIP files;

### v0.8.6 2023-01-15

* [Added] User Token API project list includes project creation time;
* [Added] User Token API project list includes project document count;
* [Added] Ability to disable sitemap in configuration file;
* [Optimized] Handling of user-owned content when deleting a user;
* [Optimized] Project authors can download documents created by collaborators;

### v0.8.5 2022-11-30

* [Added] Test email sending function for email configuration;
* [Added] Option to disable update checking;
* [Fixed] Project failing to run on some devices due to importlib-metadata version changes;
* [Optimized] Removed iframe whitelist configuration and restrictions;
* [Optimized] Added color slots for card-style code blocks;
* [Optimized] Merged PR #153;

### v0.8.4 2022-10-31

* [Added] X_FRAME configuration option allowing embedding in cross-origin iframes;
* [Added] Project URL format `/project/xxx/`;
* [Fixed] Code not highlighting or being copyable on tag document pages;
* [Optimized] Switching between precise search and full-text search on the global search page;

### v0.8.3 2022-09-30

* [Fixed] Editor default selection not showing in personal settings;
* [Fixed] Login with redirect parameter not redirecting correctly after success;
* [Fixed] Garbled Chinese names when importing projects;
* [Optimized] Admin panel left sidebar labels;
* [Optimized] Text prompts on personal center’s token management page;
* [Optimized] Merged PR !29 (Optimize Dockerfile);
* [Optimized] Adjusted document URL format to /doc/xxx;

### v0.8.2 2022-08-31

* [Added] One-click copy for code blocks in Editor.md;
* [Fixed] Online tables in document sharing not adapting to browser size;
* [Fixed] Sequence diagrams not rendering in editor.md;
* [Optimized] Dots in document names after importing local TXT files;
* [Optimized] Removed donation popup from document pages;
* [Optimized] Improved exception messages when creating users/admins in backend;
* [Optimized] Updated text description for attachment whitelist configuration;
* [Optimized] Export project popup styling in personal center;
* [Optimized] Link to attachment management in document editor’s attachment picker;

### v0.8.1 2022-07-31

* [Fixed] Image uploads being overwritten in certain situations;
* [Optimized] Updated copyright info at bottom of search homepage;
* [Optimized] Default uWSGI configuration;
* [Optimized] Removed deprecated emoji tab from editor.md;
* [Optimized] Link to document template management in document editor;
* [Optimized] Version check logic; removed default update reminder popup;
* [Optimized] Mobile page iframe styling;

### v0.8.0 2022-06-30

* [Fixed] editor.md not rendering `mark` tags inside timelines;
* [Fixed] Incorrect permission check in user token API for modifying documents;
* [Fixed] Firefox causing high CPU usage on login, register, etc. pages;
* [Optimized] Direct navigation from project page to personal center project management;
* [Optimized] Direct navigation from document page to personal center document management;
* [Optimized] Direct navigation from new document page to personal center project/document management;
* [Optimized] Direct navigation from edit document page to personal center document management;
* [Optimized] Updated footer branding to “Powered By MrDoc”;
* [Optimized] Navigation from document template edit page (new/edit) to personal center menus;

More version update details can be found in the [CHANGELOG](https://github.com/zmister2016/MrDoc/blob/master/CHANGES.md).