Appearance
Markdown Syntax
Every kind of Markdown WriteRoom reads, and the command that types it for you. Follow the links for the details.
The Markdown.pl flavor reads a few of these differently.
Text
| You type | For | Command |
|---|---|---|
*italic* or _italic_ | Italic | Format > Italic (Command-I) |
**bold** or __bold__ | Bold | Format > Bold (Command-B) |
***both*** | Bold italic | |
~~struck~~ | Strikethrough | Format > Strikethrough (Shift-Command--) |
==highlighted== | Highlight | Format > Highlight (Shift-Command-H) |
`code` | Inline code | Format > Code > Inline Code (Shift-Command-M) |
x^2^ | Superscript | |
H~2~O | Subscript | |
$E = mc^2$ | Math | |
:smile: | An emoji | |
— or — | A character by name or number | |
\* | A plain *, not a mark |
Superscripts and subscripts can't contain spaces.
To remove the marks from a selection, use Format > Clear Formatting (Command-\).
Links
| You type | For | Command |
|---|---|---|
[text](https://example.com) | Link | Format > Links & Footnotes > Add Link… (Command-K) |
[text](https://example.com "Title") | Link with a title | |
[text][1] | Reference link | Format > Links & Footnotes > Add Reference Link (Shift-Command-K) |
[1]: https://example.com | Reference link definition | |
[Soil](#soil) | Link to a heading | Edit > Copy > Link to Heading |
<https://example.com> | Link that shows its URL | |
www.example.com | Bare link (CommonMark only) | |
[^1] | Footnote | Format > Links & Footnotes > Add Footnote (Option-Command-K) |
[^1]: The note. | Footnote note |
Images
| You type | For |
|---|---|
 | Image |
{width=50%} | Image with a width |
![A tide pool][pool] | Reference image |
To add an image, drag it in or paste it. See Attachments.
Headings
markdown
# Heading 1
## Heading 2
###### Heading 6
Also Heading 1
==============
Also Heading 2
--------------
## Installing {#setup}Use Format > Headings (Command-1 to Command-6). The {#setup} gives a heading its own anchor for links. See Headings for Structure.
Paragraphs and Line Breaks
Leave a blank line between paragraphs. End a line with \ or two spaces to keep the line break inside a paragraph. Use Edit > Insert > Line Break (Shift-Return).
Lists
markdown
- A bullet
* Also a bullet
+ Also a bullet
1. A number
2) Also a number
- [ ] A task
- [x] A done task
Term
: Its definitionIndent an item to nest it. See Lists.
The last one is a Definition List: a term on one line, then : and its definition.
Quotes
markdown
> A quote
>
> > A quote inside a quoteUse Format > Quote (Shift-Command-').
Code
markdown
```swift
let greeting = "Hello"
```
~~~
Tildes work too.
~~~
Or indent four spaces.Name a language after the opening fence to color it. Use Format > Code > Code Block (Option-Command-C). See Quotes and Code.
Math and Diagrams
markdown
$$
\int_0^1 x^2 \, dx = \frac{1}{3}
$$
```mermaid
graph LR
Draft --> Revise
```A code block named mermaid or svg draws as a diagram. See Images & Diagrams.
Tables
markdown
| Name | Age |
| ------- | --: |
| Ada | 36 |Colons in the dashes align a column: :-- left, :-: center, --: right. Use Format > Table > Insert Table. See Markdown Tables.
Horizontal Rules
Put ---, ***, or ___ on a line of its own. Use Edit > Insert > Horizontal Rule (Control-Command--).
Front Matter
markdown
---
title: Tide Pools
---A block of settings between --- lines at the very top of a document. WriteRoom folds it when the document opens, and exports start with its title.
Attributes
{#id .class key=value} adds an id, classes, or settings to a heading, an image, or a [span of text]. Web page exports keep them.
HTML and Comments
HTML tags and <!-- comments --> stay as you wrote them, and pass through to web page exports. A Table of Contents lives between two comments.