Supported Markdown
Resomark reads and writes ordinary Markdown files. It supports CommonMark and GitHub Flavored Markdown (tables, task lists, strikethrough), plus syntax common in editors such as Obsidian and Typora: highlights, footnotes, math, Mermaid diagrams, callouts, frontmatter and [[wikilinks]]. It adds no format of its own, so your files open in any editor.
Blocks
Section titled “Blocks”| Syntax | Example | Notes |
|---|---|---|
| Heading | # Heading to ###### Heading |
Headings underlined with === / --- on the next line work too |
| Quote | > text |
Can be nested |
| Bulleted list | - item (or *, +) |
|
| Numbered list | 1. item |
Numbering continues automatically |
| Task list | - [ ] to do, - [x] done |
Click the box to check it |
| Code block | Three backticks ``` plus a language name |
Highlighted by language |
| Horizontal rule | --- |
|
| Table | GitHub-style tables | Edit right in the cells |
| Math | $$ … $$, each $$ on its own line |
Typeset with KaTeX |
| Mermaid diagram | A code block whose language is mermaid |
Drawn as a diagram; on errors, shows the source and the error |
| Callout | > [!NOTE] with each following line starting with > |
Five types: NOTE, TIP, IMPORTANT, WARNING, CAUTION |
| Frontmatter | YAML between --- lines at the top of the file |
Shown as is, not folded |
| Footnote | [^1] in the text, [^1]: note at the end |
Inline
Section titled “Inline”| Syntax | Example |
|---|---|
| Bold, italic | **bold**, *italic* |
| Strikethrough | ~~deleted~~ |
| Highlight | ==highlight== |
| Underline | <u>underline</u> |
| Inline code | `code` |
| Superscript, subscript | ^superscript^, ~subscript~ |
| Inline math | $E=mc^2$ |
| Link | [text](https://example.com), [text](other-file.md#heading) |
| Wikilink | [[file name]], [[file name|display text]], [[file name#heading]] |
| Image | ;  sets the size; ![[a.png]] works too |
| Web address | A bare https://… becomes a link |
| Emoji | :smile: shows as 😄 |
For how to write wikilinks and how completion works, see Links and backlinks.
HTML in documents
Section titled “HTML in documents”HTML and SVG written in Markdown are displayed. HTML with scripts runs in an isolated environment that can't reach Resomark or your other files; when you zoom in to look at it, it can open in a window of its own. HTML in a code block is shown as code and isn't run.
What's different from elsewhere
Section titled “What's different from elsewhere”- No indented code blocks: text indented four spaces is still an ordinary paragraph (notes often have deep indents). Use three backticks for code.
- Only five callout types: other Obsidian types (such as
[!info]and[!question]) show as ordinary quotes. - Only images can be embedded:
![[image.png]]shows the image;![[note]]doesn't embed that note. - Tags:
#tagis plain text, and there's no tag pane.