MARKDOWN.md

Markdown Guide

This guide covers all supported syntax for creating rich content in your notes. The editor uses an extended version of GitHub Flavored Markdown (GFM) that includes standard syntax as well as several custom HTML tags for advanced formatting.

---

Standard Markdown

These are the foundational elements for formatting your text.

Text Formatting

Style	Syntax	Example
Bold	**Bold Text**	Bold Text
Italic	*Italic Text*	Italic Text
Strikethrough	~~Strikethrough~~	Strikethrough
Inline Code	`Inline Code`	Inline Code
Link	[Google](https://google.com)	Google
Image		An image will be displayed
Blockquote	> Quoted text	> Quoted text
Horizontal Rule	---	A horizontal line will appear

Headings

# Heading 1

## Heading 2

### Heading 3

Lists

Unordered List

- Item 1
- Item 2
  - Nested Item

Ordered List

1. First Item
2. Second Item
3. Third Item

---

Advanced Elements

Task Lists

You can create checklists with interactive checkboxes directly in the editor.

- [x] Completed task
- [ ] Incomplete task

Tables

Create tables using standard Markdown pipe syntax or raw HTML.

| Feature       | Status    |
| ------------- | --------- |
| Highlighting  | Supported |
| Keyboard Keys | Supported |

Code Blocks

Wrap your code in triple backticks. You can specify a language for syntax highlighting.

javascript
function helloWorld() {
  console.log("Hello, world!");
}

Callouts

Callouts are styled blocks that help highlight important information. They use the GitHub/Obsidian-style syntax and come in four types:

You can use !INFO, !WARNING, !SUCCESS, !DANGER.

> [!INFO]
> This is an informational callout for general tips and notes.

[!INFO] In the visual editor, you can insert callouts using the /callout slash command and change the type by clicking the icon.

---

Custom HTML Tags

For more advanced formatting, you can use the following HTML tags directly in the editor. They will persist when switching between editor modes and will render correctly in the final view.

Element	Description	Syntax & Example
Keyboard Key	Enter	<kbd>Enter</kbd>
Highlight	important	<mark>important</mark>
Subscript	H2O.	H<sub>2</sub>O
Superscript	E=mc2	E=mc<sup>2</sup>
Abbreviation	HTML	<abbr title="HyperText Markup Language">HTML</abbr>.
Collapsible Section	Click to see more This content is hidden by default but can be expanded	<details>     <summary>Click to see more!</summary>      This content is hidden by default but can be expanded.  </details>
Colored text	Magenta text	<span style="color: magenta">Magenta text</span>
File Attachment	Creates a special link formatted as a downloadable file.	[📎 report.pdf](/path/to/file)
Video	Adds an embedded video to the note.	[🎥 video.mp4](/path/to/video)
Image