Markdown syntax guide
Diary, daily report, and micro-report inputs support GitHub Flavored Markdown. The basics below are enough to get started. Once you are comfortable, you can also use tables, alerts, task lists, and diagrams. # / ## / ### correspond to the H1, H2, and H3 buttons in the editor.
Basic syntax — this is all you need
| Write | Preview |
|---|---|
| Headings | |
# Heading 1
## Heading 2
### Heading 3 | |
| Text styles | |
**Bold**
*Italic*
~~Strikethrough~~
`Code` | Bold Italic
|
| Lists | |
- Bullet list
1. Numbered list
- [ ] Incomplete
- [x] Complete |
|
| Other | |
> Quote
[Link](https://effica-grove.com)
--- | |
Text styles
**Bold** *Italic* ~~Strikethrough~~ `Code`
Bold
Italic
Strikethrough
Code
Lists
- Bullet list 1. Numbered list - [ ] Incomplete - [x] Complete
- Bullet list
- Numbered list
- Incomplete
- Complete
Other
> Quote [Link](https://effica-grove.com) ---
Syntax that makes daily reports easier
These are handy for organizing reviews. The left side is the Markdown; the right side is the rendered result.
Table
Separate columns with |. Use :--- to choose alignment.| Type | Due | Source | | :--- | :---: | ---: | | Daily | Every day | Micro-reports | | Weekly | Weekend | Daily reports | | Monthly | Month end | Weekly reports |
| Type | Due | Source |
|---|---|---|
| Daily | Every day | Micro-reports |
| Weekly | Weekend | Daily reports |
| Monthly | Month end | Weekly reports |
GitHub Alerts
Use > [!NOTE] and five other types to call out notes, tips, and warnings.> [!NOTE] > A helpful note. > [!TIP] > A small tip. > [!IMPORTANT] > An important point. > [!WARNING] > Something to watch out for. > [!CAUTION] > An irreversible action.
Note
A helpful note.
Tip
A small tip.
Important
An important point.
Warning
Something to watch out for.
Caution
An irreversible action.
Heading anchors and table of contents
Headings automatically become link targets, and a "## Table of Contents" heading generates a table of contents.## Table of Contents ## What I did today Body text. ### Details Body text. ## What I will do tomorrow Body text.
Body text.
Body text.
Body text.
How to use the editor
Three view modes
Switch between Edit / Preview / Split from the tabs at the top. Split is desktop only; on mobile you get Edit and Preview.
Two view modes
Switch between Edit / Preview from the tabs at the top. Split view is desktop only.
Insert from the toolbar
Headings, bold, lists, links, and emojis are all available as buttons. You do not need to memorize the syntax.
Character counter
A rough character count appears at the bottom. You can still save when you go over it (nothing gets truncated).
Try the editor
External links in your text open in the same tab, just like on GitHub, and carry rel="nofollow" for search engines. Use the browser Back button to return to the record.