Skip to content
Etonymdocs

Markdown support

Etonym reads CommonMark with the GitHub additions (tables, task lists, strikethrough). It never changes syntax it does not format: that text stays in the file as you wrote it.

Syntax Example
Headings # Title to ###### Title
Bold, italic, strikethrough **bold**, *italic*, ~~gone~~
Inline code and code blocks `code`, fenced blocks with syntax colors
Quotes > quoted, nested too
Lists and task lists - item, 1. item, - [ ] task, - [x] done
Horizontal rule ---, ***, ___
Links [text](path.md), [[Note]], [[Note#Heading]], [[Note|label]]
Images ![](image.png), ![[image.png]], <img src="image.png" width="300">
Tables GitHub-style tables, see Tables
Diagrams ```mermaid blocks, see Diagrams
Frontmatter the --- block at the top, shown as a Properties table, see Editor
Tags #tag, highlighted
Highlight ==text==
Comments %%comment%%, <!-- comment -->, shown dimmed
A few HTML tags <br>, <sup>, <sub>, <kbd>, <u>, <mark> without attributes
  • Headings underlined with === or ---
  • Reference links, such as [text][ref]
  • Footnotes, such as [^1] and [^1]: Note text
  • Bare web addresses, such as https://example.com or <https://example.com>. They do not open with Ctrl+click. Write [text](https://example.com) for a link.
  • Math, such as $x^2$
  • Note embeds, ![[Note]] for a note rather than an image
  • Images from http: or https: addresses (see Images)
  • Any other HTML, and HTML tags with attributes. Etonym never runs or renders HTML inside a note.

Links Etonym writes are always standard Markdown links, so notes stay readable on GitHub, GitLab and in other editors.