Skip to content

Markdown render

Markdown Engine (ME) is a markdown rendering engine that enhances HTML content generated by the default Rust crate by injecting JavaScript plugins.

Features

Markdown Engine (ME) now supports:

  • Headers (h1 to h6)
  • Links
  • Bold, Italic, Strikethrough
  • Images
  • Tables
  • Blockquotes
  • Task lists
  • Unordered and Ordered Lists
  • Inline and Block Code (with syntax highlighting)
  • MathJax formulas
  • Mermaid diagrams
  • HTML tags

Third-party Libraries Loaded on README File Rendered:

Markdown flags alerts (!note, !important, !warning...) are not supported yet.

Standard Directory where README.html Files are Generated

System Location
Linux home/<YOUR_USERNAME>/.config/scimon/readme
MacOS /Users/<YOUR_USERNAME>/Library/Application Support/scimon/readme
Windows C:\Users\<YOUR_USERNAME>\AppData\Roaming\scimon\readme