Everything below is real output
Each example is rendered in your browser by orz-markdown itself, right now. Source on the left, the actual result on the right. Want to play? Drop any of it into the editor.
The {{ }} plugins
One uniform syntax for rich embeds:
{{name args}} inline, or {{name⏎…⏎}} across lines. No HTML required.
Full plugin reference
| Plugin | Example | Result |
|---|---|---|
qr | {{qr https://orz.how}} | inline QR (scannable, click to enlarge) |
youtube / yt | {{yt dQw4w9WgXcQ}} | a responsive video embed (an id or a YouTube URL; ?t=42 sets the start) |
mermaid / mm | {{mm⏎graph LR⏎A-->B⏎}} | a diagram |
chart | {{chart⏎type: bar⏎…}} | bar / line / pie / doughnut charts |
smiles / sm | {{sm C1=CC=CC=C1}} | a chemical structure |
emoji / em | {{emoji wave}} | emoji by name |
span / sp | {{sp[red] text}} | colored / badged spans |
toc | {{toc 2,3}} | a table of contents |
attrs | # Title{{attrs[#id]}} | ids, classes, attributes |
space | {{space 4}} | inline horizontal space (rem, at most 100) |
md / markdown / md-include | {{md ./part.md}} | include another Markdown file — only when the host allows file access; URLs are resolved beforehand by prepareSources() |
nyml, yaml / yml | {{nyml⏎key: value⏎}} | invisible data for scripts and document metadata |
The ::: containers
Semantic callouts and real layout, from fenced blocks. Nest by adding colons to the outer block.
All container types
Callouts: info, success, warning, danger.
Layout: left / right / center, cols, tabs,
spoil (spoiler). Any other ::: ClassName becomes a
<div class="ClassName">, so you can style your own.
::: info :::: cols 1 2 :::: tabs
…content… ::: col ::: tab One
::: … …
::: :::
:::: ::::Math with KaTeX
Inline $…$ and display $$…$$,
rendered at parse time. mhchem is bundled for chemistry. Macro definitions
(\def, \newcommand) are not supported and show as source — write the expanded TeX;
a formula over 10,000 characters also shows as source.
Diagrams & charts
Flowcharts, data charts, and chemistry, all from plain text. (These libraries load on demand.)
Twelve built-in themes
Light and dark, academic to playful. A theme styles the full rendered output, including containers, math, diagrams, and print. Switch instantly in the editor.
Chinese and English, side by side
Emphasis works next to CJK punctuation
(**注意：**请先阅读), a line wrap between Chinese characters adds no space, and a bare URL next to
Chinese links only the URL (访问https://orz.how获取). Chinese written onto a URL path stays in the
link, so put a space or punctuation after a URL that prose follows.
Copy as Markdown
With the browser runtime loaded, selecting rendered content and copying puts Markdown source on your clipboard, not HTML.
It round-trips
Tables, lists, math, code, and even generated constructs survive the trip. Copy a rendered QR and you get
{{qr …}} back; copy a diagram and you get its {{mermaid …}} source.
Why it matters
Your rendered document stays the source of truth. Paste into any editor, chat, or issue and it is clean, portable Markdown again, ready to re-render anywhere.
