Markdown Cheatsheet

system · February 1, 2021, 3:05pm

Agenda is not a markdown editor, but it does recognize some markdown syntax for applying styles. Here are markdown shortcuts that can be used.

Paragraph Styles

The following styles change the appearance of the entire paragraph.

Heading

Use 1-6 hash symbols at the beginning of the line, followed by a space. The heading level is given by the number of hashes.
E.g.
### Sample
produces a third level heading.

Dashed or Bullet List

Begin a line with a bullet, hyphen, asterix or plus sign to make a dash list item.
E.g.
• Sample Item 1
- Sample Item 2
* Sample Item 3
+ Sample Item 4
produces a dashed or bullet list item.

Check List

Begin a line with a hyphen followed by a opening square bracket and a closing square bracket. Inserting an “x” between the two brackets creates a checked item.
E.g.
-[ ] Sample
produces a check list item.

-[x] Sample
produces a checked item.

The hyphen is optional, so you can also create a checkbox just using two square brackets.

Preformatted

For content that works best in a fixed width font, such as computer code, you can apply the preformatted style. You can trigger this style by starting the line with three tick marks.
E.g.
```sample produces sample

Inline Styles

These styles are used inside of paragraphs to change text appearance.

Italic

Enclosing in underscores or asterisks gives italic styling.
E.g.
_sample_ or *sample* produces sample

Bold

Enclosing in double underscores or double asterisks gives bold styling.
E.g.
__sample__ or **sample** produces sample

Strikethrough

Enclosing in double tildes gives strikethrough styling.
E.g.
~~sample~~ produces ~~sample~~

Fixed Width (Monospaced)

For some content, such as computer source code, it is preferable to have fixed width text. For blocks of text, it is best to use the Preformatted paragraph style. For inline text, you can enclose in back ticks.
E.g.
`sample` produces sample

Insert

Some styles are not related to the meaning of the text, but are used to delineate informational elements such as tags. These can also be entered using markdown-like syntax.

People Tags

Agenda recognizes a second type of tag reserved for individuals (people). You can enter a name or initials to refer to a friend or colleague. Just enter a @ symbol in front of the text.
E.g.
Enter @Tom to create a person tag for someone called “Tom”.

Horizontal Rule

If you like to visually delineated sections within your notes using a horizontal rule (a horizontal line), you can do so by typing three dashes in a row followed by a space:
E.g.
Enter --- to create a horizontal rule.

Tip: If you are importing a markdown file, you can have it split into individual notes in Agenda using the same three dashes in a row:
E.g.
First note
---
Second note

This will create two different notes, the first with content “First note”, and the second with content “Second note”.

Tables

Agenda gives you the ability to insert tables in your notes, which you can quickly create by typing three or more pipe (|) symbols in a row at the start of the line:
E.g.
Enter ||| to insert a table.

Links

Links are automatically recognized in text, but you can also add them with markdown syntax. Use square brackets to enclose the text that is displayed, followed by parentheses enclosing the link URL.
E.g.
Enter [Agenda](agenda.com) to create a link to agenda.com attached to the text “Agenda”.

Actions (e.g. adding a reminder)

Though not strictly part of classic markdown syntax, Agenda allows triggering certain actions if you start by typing a backslash \ symbol, followed by an action.

For example \remind will trigger the insertion of reminder in your note. Optional parameters can be provided as part of the action, for example, \remind(today at noon) will schedule a reminder for today at noon. Other common actions are \now, \date, and \time, to insert the current date and time.

For a complete overview of all actions, see Creating and Using Templates and Actions