Manual / Mare 0.21
Writing
Mare speaks markdown, and is polite enough to hide it. Type the markers to get the formatting. Move the caret back into the text to show the markers again and change them.
| Type this | Get this |
|---|---|
**bold** |
bold |
*italic* |
italic |
~underline~ |
underline |
~~strike~~ |
|
==highlight== |
highlight |
| a backtick on each side of a word | code |
# at the start of a line |
a heading (## and ### for smaller ones) |
Want an emoji? Type a colon and the start of its name, as in :ey → pick 👀 from the suggestions. The names are the same as on GitHub and Slack.
Enter starts a new paragraph, with some space above it. Shift+Enter starts a new line in the same paragraph, for an address or a verse. In the file, that line break is written <br>.
Prefer to click? ↓ The formatting bar at the bottom of the editor has a button for each of these. A button is highlighted when the caret is in text with that formatting. The right-click menu has the same options.
Spellcheck
Mare underlines misspelled words as you write. It looks the way your system does it: dots on Apple devices, a wavy line on Windows and Linux, a straight line on Android.
- Right-click a word → suggestions. Pick one to replace the word
- On a phone or tablet, tap the word → the formatting bar shows the suggestions, with Add and Ignore
- Add to dictionary → the word is accepted from now on. Ignore accepts it until you close Mare. On a Mac these are Learn Spelling and Ignore Spelling, and learned words are shared with your other apps
- The word you're typing isn't checked until you move on
- Code, links, tags and file names are never checked, so a note full of commands stays clean
- More than one language? A word is fine if any of your languages knows it. A Mac also detects the language of each paragraph
You choose the languages under Settings → Editor. See "Make it yours" below.
Lists, todos and friends
-starts a bullet,1.a numbered list,- [ ]a todo- Tab indents an item one level. Shift+Tab moves it back. Mare renumbers the list, you have better things to do
- Click a todo's checkbox to tick it, or press Ctrl+Enter with the caret on it
>starts a quote---on its own line draws a horizontal line
Callouts
A quote that starts with a label in square brackets becomes a coloured box. There are five labels: NOTE, TIP, IMPORTANT, WARNING and CAUTION.
Tables
Type a row with bars between the cells, like | Name | Age |, and press Enter. Tab moves to the next cell. Enter moves to the cell below. A column can hold choices, checkboxes, dates or numbers as well as text. You can also sort a column and show a summary under it. See Tables below.
Code
Type three backticks and press Enter to open a code block. Mare closes it for you. Add a language after the backticks (python, go, sql and a few hundred more) for syntax highlighting. Hover the block for a copy button.
A block marked mermaid is drawn as a diagram. Click the diagram to see and edit its code. The first time, Mare asks before it downloads the small program that draws diagrams.
Footnotes
Write [^1] where the number should go. Then write [^1]: the note itself on its own line, usually at the end.
Folding
Hover a heading → an arrow appears in the margin. Click it to fold everything under that heading. Ctrl+' does the same.