Writing in the Markdown editor
Write in Markdown, add blocks from the slash menu, move and copy blocks, draw diagrams, and find and replace text.
The editor is where you write a doc, a post or a comment. What you type is Markdown: you can type the Markdown marks yourself, or use the menus and keys, and sfora keeps the text as plain Markdown either way.
- A heading. Type ## and a space at the start of a line.
- A list. Type - and a space at the start of a line.
Type Markdown
Type these at the start of a line, then a space:
| Type | You get |
|---|---|
#, ##, ### | A heading, from the largest down |
- or * | A bulleted list |
1. | A numbered list |
[ ] | A to-do item; [x] for a done one |
> | A quote |
Type ``` to start a code block, and --- for a divider. Within a line, wrap text in **two stars** for bold, *one star* for italic, and `backticks` for code.
To format text you've already written, select it. A toolbar appears with Bold, Italic, Strikethrough, Inline code and Link.
Add a block from the slash menu
Type /. In an empty doc, the body says "Type '/' for commands".
Keep typing to narrow the list, for example /tab for Table.
Press ↵ to insert the block.
The menu offers:
- Text: Heading, Heading 2, Heading 3.
- Structure: Bulleted list, Numbered list, Todo list, Code block, Quote, Callout, Table, Divider.
- Rich blocks: Diagram, Status timeline, Board, Conversation, Data sheet, Map.
- Templates: Standup, Summary, Release notes, Shipped, Question.
The slash menu doesn't open inside a code block.
Move, copy and change a block
Point at a block. A handle (⋮⋮) appears at its left. Drag it to move the block, or click it for a menu:
- Turn into changes the block's kind, for example a paragraph into a heading or a list.
- Duplicate adds a copy below it.
- Move up and Move down move it past its neighbour.
- Copy as Markdown puts the block's Markdown on your clipboard, ready to paste anywhere.
- Delete removes it.
Each has a key, so you don't need the menu; see the table below. The keys act on the block the cursor is in.
A comment has no block handle, and ⌘CtrlD and ⌘Ctrl⇧ShiftC don't apply there.
Draw a diagram
A diagram is a code block in the Mermaid language, which sfora draws as a picture.
Type /diagram and press ↵. Or start a code block with ```mermaid.
Write the diagram, for example graph LR and then Plan --> Build.
In the block's header, click Rendered to see the picture, or Markdown to edit its text.
Status timeline, Board, Conversation, Data sheet and Map work the same way: each is a code block that sfora draws, with the same Rendered and Markdown switch. Copy in the header copies the block's text.
Find and replace
In a doc's edit view, press ⌘CtrlF. Type in Find in document…; the bar counts the matches. Press ↵ for the next match and ⇧Shift↵ for the previous one. Aa matches case, and ab matches whole words only.
To replace, press ⌘Ctrl⌥AltF with the bar open, or click Show replace. Type in Replace with…, then press ↵ to replace one match, or ⇧Shift↵ or Replace all to replace every match. Press Esc to close the bar.
Keyboard shortcuts
| Key | What it does |
|---|---|
| ⌘CtrlB / ⌘CtrlI | Bold / italic |
| ⌘CtrlE | Inline code |
| ⌘CtrlK | With text selected: add a link |
| ⌘Ctrl⌥Alt↑ / ⌘Ctrl⌥Alt↓ | Move the block up or down (⌘Ctrl⇧Shift↑ / ⌘Ctrl⇧Shift↓ also work) |
| ⌘CtrlD | Duplicate the block |
| ⌘Ctrl⇧ShiftC | Copy the block as Markdown |
| Tab / ⇧ShiftTab | In a list: indent or outdent the item |
| / | Open the slash menu |
| ⌘CtrlF | In a doc: find |
| ⌘Ctrl⌥AltF | In a doc, with find open: replace |
Troubleshooting
Mod+F does nothing
Find works in a doc's edit view. Switch the doc to edit (see Docs), click into the text, and press ⌘CtrlF again.
The slash menu doesn't open
The cursor is inside a code block, where / types a slash. Move the cursor to a line below the block and type it there.
A diagram shows as text
The block is set to Markdown. Click Rendered in its header. If it still doesn't draw, check the diagram's text for a typo.
Last updated on