Markdown basics

Oyma edits plain Markdown with a live preview: formatting displays as you type, and the markers that create it stay out of the way. Notes are ordinary .md files, so anything you write here opens in any other Markdown editor.

How the live preview works

By default, markers such as ** and ~~ stay hidden, so a note reads like formatted text. Links, comments and frontmatter show their source when your cursor moves into them, so you can edit them. If you prefer to see every marker where you’re typing, turn on Show syntax on the active line in Settings › Editor.

Press ⌘E to switch the current tab to read mode, where the note can’t be edited, and press it again to go back.

Standard Markdown

You type	You get
# Heading to ###### Heading	Headings, levels 1–6
**bold**, *italic*	Bold, italic
~~struck~~	Strikethrough
`code`	Inline code
- item, 1. item	Bulleted and numbered lists
- [ ] task	A checkbox you can click
> quote	Blockquote
[text](https://…)	Link. ⌘-click to open it
A bare URL	Link
	Inline image
```js … ```	Code block with syntax highlighting
---	Horizontal rule

Tables use the GitHub syntax and turn into an editable grid. See Tables.

Extensions

These come from Obsidian and other note apps, and work the same way here.

• Wikilinks: [[Note]] links to another note by title. [[Note|text]] changes the displayed text. Details are in Links, backlinks and the graph.
• Tags: #tag anywhere in the text, and #area/topic for nested tags. Tags inside code blocks and on heading lines are ignored.
• Highlights: ==highlighted text==.
• Comments: %%like this%%. A comment is hidden in the preview and reappears when your cursor moves into it.
• Footnotes: text[^1] with a definition line [^1]: The note. The reference displays as a small superscript.
• Callouts: start a blockquote with a type, such as > [!note] Optional title. Recognized types include note, info, tip, success, warning, error, abstract, todo, question, quote, example, danger and bug. Any other type uses the note style.
• Embeds: ![[image.png]] shows the image inline, and ![[image.png|240]] sets its width in pixels. ![[Another note]] shows a chip that opens the note.
• Frontmatter: a YAML block at the very top of the note, between --- lines. It displays as a properties block. Click into it to edit the YAML.

Faster ways to format

• Shortcuts: ⌘B bold, ⌘I italic, ⌘` inline code, ⌘⇧X strikethrough, ⌘⇧H highlight, ⌘K link.
• Slash commands: type / at the start of a line for headings, lists, a task list, a quote, a code block, a table, a horizontal rule, three callout types and dates.
• Right-click menu: Format, Paragraph and Insert submenus cover the same actions, including footnotes and callouts.
• The command palette: press ⌘O, type > and the name of a format, such as >Heading 2 or >Task list. See Search and the command palette.
• Dates: type @today, @yesterday, @tomorrow or @now to insert the date (and time, for @now).

Lists continue when you press Enter, and quotes and dashes are converted to typographic ones as you type. You can turn those substitutions off in Settings › Editor.

Folding

Click the chevron next to a heading to collapse its section, or press ⌘⌥[ to fold the section your cursor is in. Run Fold all headings or Unfold all headings from the command palette to do the whole note at once. Lists and code blocks fold too.

Images and attachments

Paste or drop an image into a note and Oyma saves it in an attachments folder at the top of your vault, then inserts an ![[attachments/…]] link to it.

Images written as ![alt](…) can be resized in place: click the image, then drag its corner handle. The new width is saved in the link as ![alt|width](…), the same form Obsidian uses.

What shows as plain text

Some syntax is kept exactly as you wrote it but isn’t displayed specially yet:

• Math: $E=mc^2$ and $$ … $$ blocks.
• Mermaid diagrams.
• Subscript (H~2~O), superscript (x^2^) and definition lists.

Your file is never changed to remove this syntax, so it still works in other apps that support it.