Agenda is not a markdown editor, but it does recognize some markdown syntax for applying styles. Here are markdown shortcuts that can be used.
If you are importing a markdown file, you can have it split into individual notes in Agenda.
Splitting notes does not work in the Agenda text editor: it’s only for importing files.
To have a file split into multiple notes, type three hyphens alone on a line.
This will create two different notes, the first with content “First note”, and the second with content “Second note”.
The following styles change the appearance of the entire paragraph.
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.
produces a third level heading.
Begin a line with a hyphen to make a dash list item.
produces a dash list item.
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.
-[ ] Sample
produces a check list item.
produces a checked item.
The hyphen is optional, so you can also create a checkbox just using two square brackets.
For content that works best in a fixed width font, such as computer code, you can apply the preformatted style. There is no text shortcut to produce this style; instead, you can use the Format menu or the keyboard shortcut.
These styles are used inside of paragraphs to change text appearance.
Enclosing in underscores or asterisks gives italic styling.
E.g. _sample_ or *sample* produces sample
Enclosing in double underscores or double asterisks gives bold styling.
E.g. __sample__ or **sample** produces sample
Enclosing in double tildes gives strikethrough styling.
E.g. ~~sample~~ produces
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
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.
To enter a tag, just use a # symbol, followed by the tag. The tag cannot contain spaces.
E.g. Type #giraffes to create a tag called “giraffes”.
Tags can also contain a parameter in parentheses. For example, #due(12/12/2018)
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”.
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. If you type [Agenda](agenda.com) you 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.