Write and format

# A little room to think

Keep the **important part**.

- Notice something
- Write it down
- Follow the idea

- [x] Start the draft
- [ ] Review the ending

> Give an idea somewhere to go.

The everyday syntax

To write	Use this Markdown
Main heading	# Document title
Section heading	## A section
Bold	**important words**
Italic	*a little emphasis*
Inline code	`filename.md`
Bulleted list	- A list item
Numbered list	1. First step
Quotation	> A quoted thought
Task	- [ ] Something to do
Finished task	- [x] Something done
Link	[Link text](https://commonmark.org/)
Local image	

Leave a blank line between paragraphs and around lists or other blocks when the structure is unclear. Indentation can change meaning, especially inside lists and code blocks.

Use the formatting and insert tools

The formatting bar works on Markdown source. Select text before applying bold, italic, inline code or a heading. Insert tools add links, images, tables, emoji, symbols, alerts, diagram starters and highlight colours without memorising every mark.

For an image, write a useful description of what it shows. A local image reference needs the image file to remain at the relative location named in the document. When you choose an image file through the insert tool, or drop a file onto the editor, editmd copies it into an attachments folder beside the current document and inserts the link for you.

Code blocks

Place three backticks before and after code. Put a language name after the opening backticks for syntax highlighting. For example:

```javascript
const thought = 'Keep it simple';
```

Tables and tasks

| Task                   | Owner |
| ---------------------- | ----- |
| Write the introduction | Me    |

- [x] Start the draft
- [ ] Review the ending

A supported task checkbox in the Mac preview changes the corresponding Markdown marker. Ambiguous or disabled tasks remain read-only. Other Markdown apps may handle task interactions differently.

Math, diagrams and notes

editmd supports math through KaTeX and diagrams through Mermaid. Use the insert tool for a Mermaid starting point, then edit its source. Syntax errors can leave a block unrendered; check the source before assuming the text is lost.

Footnotes, GitHub-style alerts and highlighted text are also supported. These extensions may not display identically in another editor or export format.

What is YAML?

YAML is a text format for structured data. A key such as title names a value; a list groups several values. YAML stands for “YAML Ain’t Markup Language.” Markdown structures the writing itself, while YAML can describe that writing with metadata. See the YAML specification for the language and its data types.

A standalone YAML file usually ends in .yaml or .yml. A YAML block at the beginning of a Markdown document is called front matter. Its opening and closing --- lines separate metadata from the body. Front matter is a convention supported by particular tools, rather than part of core CommonMark syntax.

Add a YAML header

Use Add YAML Header or ⌘⇧Y to insert metadata at the start of a document. If a header already exists, editmd focuses it instead of adding another. Metadata stays in the Markdown file and is kept out of the rendered document body.

---
title: 'Field notes'
tags:
  - writing
  - research
draft: true
---

Here, title is text, tags is a list and draft is a boolean value. Indent nested values with spaces, not tabs. Quoting text can make the intended value clearer, especially when it contains punctuation such as a colon. These are YAML rules; the specification’s examples show more structures.

The keys in this example are illustrative metadata. A publishing tool decides whether draft or tags has an effect; adding them does not turn on a corresponding editmd feature. Valid YAML and valid configuration for a particular tool are separate checks.

Front matter remains readable in the source file even when it is hidden from the preview. Keep credentials out of document metadata. To learn how different destinations handle the rest of your document, see Copy, export and share.

Find and replace

Use ⌘F to find text in the current document, or ⌘⌥F for Find and Replace. Check the case and regular-expression options before replacing text. Review the match count, try one replacement, then use Replace All when the pattern is right.