Draw a diagram from a few lines
Write a flowchart, a state diagram or a sequence diagram as text in a note, and Soundings draws it.
Some things are easier to see than to read: what happens on a request, the states a machine moves between, who calls whom. Write a few lines in a note and Soundings draws them.
The lines are written in the way other note apps and code sites already understand, so a note you export still draws its diagrams where you take it.
The quickest start
Under the capture box, select Add a diagram. A flowchart skeleton is written into the box with the cursor inside the first box, ready for you to name it. Fill in the two boxes, and the drawing appears when you save.
Before you begin
- Write the lines in a code block: a line of three back quotes, then the word
mermaid, your lines, then three more back quotes. In the capture box, paste or type them with Shift and Enter between the lines. - Soundings draws three kinds. A block of any other kind stays as it is, shown as code.
The three kinds
| The first line | What it draws | A line under it |
|---|---|---|
flowchart LR or graph TD | Boxes joined by arrows | A[Request] --> B{Cached?} |
stateDiagram-v2 | States and what moves between them | Idle --> Running: start |
sequenceDiagram | Who sends what to whom, in order | Browser->>Server: GET /page |
Write a flowchart
Start the block with
flowchart LR.Name each box as you use it:
A[Back up],B{Restored?}for a choice,C(Done)for a rounded box.Join them with an arrow:
A --> B.To write on the arrow, put the words in bars:
B -->|no| C, or in the middle:B -- no --> C.
Soundings draws from left to right, whichever direction you write after flowchart.
Write a state diagram
Start the block with
stateDiagram-v2.Write
[*] --> Idlefor where it starts, andRunning --> [*]for where it ends.Name what moves it along after a colon:
Idle --> Running: start.
Write a sequence diagram
Start the block with
sequenceDiagram.Write who asks whom, and what:
Browser->>Server: GET /page.Use
-->>for the answer coming back:Server-->>Browser: 200 OK. It is drawn as a dashed line.To fix the order they stand in, name them first:
participant Browser.
Read it as words
Under every diagram is What this diagram says. Open it for the same thing in sentences, one for each arrow. A screen reader reads this list; the drawing itself is named but not read.
When it is not drawn
If a line cannot be read, nothing is drawn and the whole block stays as code, so you never see half a diagram. Check that:
- the first line is one of the three above, on its own;
- each name is letters, digits, dots or underscores, with no spaces or dashes (put the words in brackets instead:
A[Two words]); - a sequence line has a colon and a message after it.
Try it: Open Courses, then a session
Related articles
- See an outline as a map: Turn a list you wrote into a map of branches, and watch it keep up while you type.
- Write notes, questions and answers: Use the capture box to write notes, park questions, answer them and file entries under topics, each at its moment.
- Add pictures, code, checklists and formulas: Paste pictures and code into an entry, and write checklists, outlines and maths formulas in the capture box.
- Export to Markdown, CSV, Word, Anki or print: Save your notes as files for other apps: Markdown for note apps, a spreadsheet of questions, a Word document, Anki cards, or a printout.