As an expert in the operation of Anqing CMS, I am well aware of the importance of content creation efficiency and the quality of presentation to user experience.The advantages of AnQi CMS in content management are largely due to its good support for Markdown syntax, which brings us great convenience and flexibility.
AnQi CMS integrates deeply with Markdown editor, committed to providing a highly efficient, flexible, and feature-rich writing environment for content creators.This integration allows us to quickly build structured content with a concise markup language, while ensuring that the front-end presents a professional and readable page effect.
Enable Markdown editor
In AnQi CMS, the first step in creating content using Markdown is to activate its built-in Markdown editor.Website operators or content administrators can easily enable this feature by accessing the backend management interface.The specific path is:Global settings -> Content settings. On this page, you can find the corresponding options to toggle the Markdown editor's on/off state.Once the editor is enabled, content creators can directly use Markdown syntax for formatting in the content editing areas of modules such as articles, products, pages, and tags.
Core Markdown syntax elements
The Anqi CMS Markdown editor supports a wide range of basic Markdown syntax elements, making content creation intuitive and efficient. Users can easily use headings (#), bold (*)Italic (List (- or 1.), Link (Image (), Code block (）以及引用（>）等常用标记来组织和美化内容。这种对标准Markdown语法的支持，确保了内容在不同平台间具备良好的一致性和可移植性，同时也提升了编辑效率。鉴于系统文档中提及可通过引入The `github-markdown-css` is used to apply default styles, which means AnQiCMS aims to provide a visual experience similar to GitHub style Markdown when rendering on the front end, covering most of the commonly used functions of standard Markdown.
Enhanced Markdown feature: mathematical formulas and flowcharts
In addition to the basic syntax, Anqi CMS also provides support for advanced Markdown features, especially the integration of mathematical formulas and flowcharts.This is an extremely useful feature for websites that need to display complex scientific expressions, technical documents, or business processes.
For the presentation of mathematical formulas, Anqi CMS relies on the MathJax third-party library. To correctly display mathematical formulas written in Markdown on the front-end page, you need to include it in the header of the template file, for example,base.htmlIn the file, introduce the CDN resources of MathJax.Once introduced, MathJax can automatically parse LaTeX syntax in Markdown content and render it as clear and professional mathematical expressions.
Similarly, for the drawing of flowcharts, sequence diagrams, and other visual content, AnqiCMS integrates Mermaid.By Mermaid, users can directly describe graphics in text form within Markdown content and automatically render them as graphical displays in the front-end page.This feature also requires the website template to bebase.htmlIntroduce the CDN resources and initialization script of Mermaid in the common header file to ensure that Mermaid can correctly identify and render the Markdown chart code block when the page is loaded.
Template-level rendering control
AnQi CMS provides fine control over the flexibility of content display, even when the Markdown editor is enabled. In template tags such asarchiveDetail/categoryDetail/pageDetailandtagDetailIn, the content field (such asContent) can be added by addingrenderparameters to manually control the Markdown to HTML conversion process.render=truewill force the conversion, whilerender=falseThis will prevent conversion. This means that website operators can decide based on specific page design or content needs whether to render Markdown content as HTML, thus achieving a more customized content display effect.For scenarios where it is necessary to display Markdown text verbatim, or for special cases where custom HTML rendering logic is required, this feature provides the necessary flexibility.
Frequently Asked Questions (FAQ)
How to enable Markdown editor in AnQi CMS?You can enable the Markdown editor feature by navigating to the "Global Settings" option in the AnQi CMS backend management interface.On this page, you can find the corresponding switches to enable or disable the Markdown editor.
2. What advanced Markdown features does AnQi CMS support, and how can they be displayed on the front-end page?The AnQi CMS supports writing mathematical formulas and flowcharts using Markdown. To display these contents correctly on the front-end page, you need to modify the website template file (usuallybase.html）的<head>Partly introduces CDN resources of MathJax for mathematical formula rendering, as well as CDN resources and initialization scripts of Mermaid for flowchart rendering.
3. Can I control whether Markdown content is rendered as HTML when using template tags?Yes. When you use templates likearchiveDetail/categoryDetailUse tags to display content fields (for exampleContent), you can addrenderparameters for fine control. Setrender=trueIt will force Markdown content to be rendered as HTML, while settingrender=falseThe original Markdown text will be retained without any conversion.