When updating the CDN version of `MathJax` and `Mermaid`, does the Anqi CMS need to manually modify the script link?
AnQi CMS is a high-efficiency and customizable content management system, dedicated to providing users with rich content display capabilities.In content creation, to support complex mathematical formulas and flow charts, etc., Anqi CMS introduces integration support for third-party libraries - MathJax and Mermaid through its built-in Markdown editor.These libraries are usually loaded through content delivery networks (CDN) to ensure ** performance and reliability.
According to the Anqi CMS documentation, if users want to display mathematical formulas and flowcharts inserted through the Markdown editor correctly on the frontend page, they need to do so in their template file (for example,base.html）的<head>Partially manually add specific CDN script links. For example, the CDN link provided for MathJax in the document ishttps://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js，specifies the third major version of MathJax, and the CDN link of Mermaid.https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjsalso clearly points to its tenth version.
This raises a key question: When these third-party libraries (MathJax and Mermaid) release new versions, do users of Anqi CMS need to manually modify the script links in these templates?
By analyzing the documents provided by AnQi CMS, we can observe that the CDN links to MathJax and Mermaid in the documents are version-locked. Specifically, the link to MathJax contains@3It indicates the lock in the third largest version of MathJax. The Mermaid link includes@10This indicates that it is locked using the tenth version of Mermaid.This version locking strategy means that as long as there are minor version updates within the MathJax 3.x series and Mermaid 10.x series (for example, from 3.0.0 to 3.1.0, or from 10.0.0 to 10.1.0), CDN services will usually automatically provide the latest minor version files for these version numbers.In this case, the user does not need to manually modify the link in the template to enjoy bug fixes or minor feature improvements brought by the minor version update.
However, the situation is different when releasing major versions. If MathJax releases a new major version (such as MathJax 4), or Mermaid releases its eleventh major version (Mermaid 11), and the users want to take advantage of the functional improvements, performance optimizations, or major compatibility fixes brought by these new major versions, then they need to take proactive intervention.In this scenario, the userYou need to manually enter the template file of its security CMS (such asbase.html)，and update the main version number specified in the link——For example, update the link of MathJax@3is modified to@4，or update the link of Mermaid@10is modified to@11.
In summary, for the CDN version updates of MathJax and Mermaid, AnQi CMS itself will not automatically modify the script links manually integrated by users in the template. If users want to upgrade to the latest major version of these libraries to obtain new features or resolve compatibility issues, they need to manually edit theirbase.htmlOr other template files that include these scripts, to update the main version number in the CDN link.This manual management method provides website stability while also requiring operation personnel to pay attention to the update dynamics of the third-party libraries they rely on.
Frequently Asked Questions
Why does Anqi CMS not automatically update these MathJax and Mermaid CDN links?Answer: The template design of Anqi CMS allows users to highly customize their websites.To ensure the stability of the website and avoid compatibility issues that may arise due to major version updates of external libraries, Anqi CMS will not automatically modify these third-party script links manually integrated into template files by users.This practice gives control to the user so that they can decide whether to upgrade the version after sufficient testing and evaluation.
Ask: Do I need to manually modify the link if I only want small version updates for MathJax or Mermaid (such as bug fixes)?Answer: Usually not needed. The version number in CDN links is usually locked to the main version of the library (for example, MathJax
@3or Mermaid@10This means that minor version updates within the same major version series (such as from 3.0.1 to 3.0.2, or 10.1.0 to 10.2.0) will be automatically provided by the CDN service with the latest files, without the need for you to manually modify the links in the template.Only when you want to upgrade to a new major version of these libraries, do you need to manually update the version number in the link.Ask: If MathJax or Mermaid releases a new version, how can I determine whether I need to update my Anqi CMS website?Answer: You should pay attention to the official release channels of MathJax and Mermaid to learn about the specific features, performance improvements, security fixes, or API changes brought by new versions.If these updates have a significant impact on your website functionality, user experience, or resolve the issues you are currently facing, then it is worth considering manually updating the CDN link.Before updating, it is strongly recommended that you validate in the test environment to ensure compatibility with your existing content and templates, and to avoid potential issues affecting the production environment.