Markdown

Everything you write here is Markdown — a note's body, a checklist item's note, a board card's description, a map node's note. Every one of those areas understands every feature on this page.

Every example below is rendered by the application itself. The left-hand side is what you type; the right-hand side is what that text becomes when it goes through the same code a note's body goes through. If the two ever disagree, this page is what is wrong.

Headings

# A heading
## A smaller one
### Smaller still

A table of contents

[TOC] on a line of its own becomes a list of every heading in the note, each one a link to its heading. Put it wherever the list belongs — at the top, or after an introduction. Like everything on this page it works in every Markdown area, and a note with no headings shows nothing there.

[TOC]

## Getting there
### By ferry
### By bus
## Where to stay

Every heading in a note can be linked to. Point at one and a # appears beside it — on a phone it is always there, faintly. Click it and the address of that heading is copied: anybody who opens it lands on that part of the note. Renaming a heading changes its address.

Emphasis

*italic*, **bold**, ~~struck through~~, and `code`.

Lists

- Bread
- Milk
  - Semi-skimmed
- Eggs

1. Ring the surveyor
2. Send the paperwork
3. Wait

Things to tick

A task line renders as a real checkbox. Ticking it in a note changes the text, and the count of what is left shows on the note itself.

- [ ] Chase the roof quote
- [x] Send the deposit paperwork

A bare [ ] at the start of a line becomes one too, without having to be a list first — because that is how people actually type them.

[ ] Book the removal van

Links and pictures

[The surveyor's report](https://example.com/report)

A link to another site opens in a new tab, so the note you are reading stays where it is. A link to somewhere in Go Scribi — another note, a subject, a heading — opens in place, like everything else here.

A picture is the same with an exclamation mark in front. Dragging a file into the editor writes this line for you and stores the file privately — served through the application, which checks who you are first.

In the LINE of a checklist item, a map node or a board card, a web address is made clickable and nothing else is formatted — see checklists. The note behind any of them takes everything on this page.

Quotes, rules and code

> What the surveyor actually said.

---

```ruby
puts "a fenced block keeps its spacing"
```

puts "a fenced block keeps its spacing"

Name the language after the three backticks — ```ruby, ```js, ```sql, ```python — and the code is coloured by kind: keywords, strings, numbers, comments. About two hundred languages are known, by their usual names and their short ones. A fence that names none is left plain.

```js
// Only the late ones
const late = departures.filter((d) => d.hour > 18)
```

// Only the late ones
const late = departures.filter((d) => d.hour > 18)

Tables

Tables need no alignment from you. However ragged the source, saving tidies it — so a table stays readable in the editor as well as on the page.

| Thing | Cost |
|---|---|
| A very long thing | 5 |
| Short | 10 |

| Thing             | Cost |
| ----------------- | ---- |
| A very long thing | 5    |
| Short             | 10   |

Either way, it renders as a table:

| Thing | Cost |
|---|---|
| A very long thing | 5 |
| Short | 10 |

Footnotes

The lease runs to 2031.[^1]

[^1]: Confirmed by the solicitor in March.

Diagrams

A fenced block marked mermaid is drawn as a diagram rather than printed as code. The diagrams page has the shapes and their syntax.

Linking one note to another

Double brackets name a subject — a person, a place, a thing — and become a link to a page gathering everywhere it has been mentioned across the workspace.

Met [[the surveyor]] about [[Ashgrove Road]].

Pasting from Google Docs or Word

Copy from a word processor, a web page or a wiki and paste it into any Markdown area here, and the formatting comes with it. Headings stay headings, bold stays bold, and lists, links, tables, quotes and code all arrive as the Markdown for them.

Pictures come across too. One that was copied along with the text — which is what Google Docs does — is kept straight away. One that was only a link to somebody else's website is fetched and kept as well, so it still works when that website changes its mind. Either way it becomes an ordinary file in the workspace, counted against its storage like anything else you upload.

A picture that cannot be fetched arrives as its description instead, and that quietly removes the things you did not mean to copy: an email's avatar, a spacer, a chat emoji. Somebody reading a note through a share link cannot add files to it, so pictures pasted there stay as descriptions.

Some things have no Markdown to become, and those arrive as plain text: colours, fonts, type sizes, alignment and indentation. Underlining, highlighting and superscript are kept as <u>, <mark> and <sup>, which Markdown has always allowed.

Apple Notes and TextEdit work too. They put RTF on the clipboard rather than HTML, which is read as well — so their bold, italics, underlining, links, tables and nested lists all come across, and an Apple Notes checklist arrives as a checklist with its ticks intact. The one thing that cannot come across is a photograph: Apple does not put the picture on the clipboard at all, only a mark where it was, so drag the image in separately.

If you wanted the plain text instead, press Ctrl/⌘ + Z once. That gives back exactly what was on the clipboard. And if anything at all goes wrong — no connection, a document too large, a page that offers no formatting — the paste falls back to plain text on its own, which is what it would have been before.

Formatting from the keyboard

HTML for what Markdown cannot say

Markdown has no spelling for underlining, highlighting, superscripts or a handful of other things, so those are written as tags. That is not a Go Scribi invention: raw HTML has been part of Markdown since the original one, so a note written this way still reads correctly in other Markdown tools.

<u>underlined</u>, <mark>highlighted</mark>, x<sup>2</sup> and H<sub>2</sub>O.

Press <kbd>Esc</kbd> to save. <ins>Added later.</ins> <small>A quieter aside.</small>

A term and its meaning:

<dl>
  <dt>Sprite</dt>
  <dd>A machine that wakes up when you talk to it.</dd>
</dl>

<samp> and <var> work too, for sample output and for a name standing in for a value. And <br> ends a line, which is easier to see than the two trailing spaces that mean the same thing.

What is not allowed

Everything else. A tag that is not on this page is removed and the words it held are kept, and an attribute that is not allowed goes the same way — so a note somebody shares with you cannot run anything, style the page around it, or load something from elsewhere.

<script>, <iframe> and <style> are gone by the time a note is drawn. So are onclick and its relatives, wherever they are written. A link whose address begins javascript: keeps its words and loses where it pointed.