Markdown render
PrimeDown is a markdown rendering engine that enhances HTML content generated by the default Rust crate by injecting JavaScript plugins.
Features
PrimeDown 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
Extra Features
- DocsSources
- Citations (References)
Learn more about how to use Extras features here.
File Formats Supported by DocsSources:
- .doc, .docx
- .epub, .mobui
- .rst, .yml, .yaml, .toml, .json
- .7z, .zip, .rar, .tar, .tar.gz, .gz
- .bin, .img
Third-party Libraries Loaded on README File Rendered:
- MathJax.js
- Mermaid.js
- Prism.js (with support for some programming languages)
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 |