Markdown starts with plain text and allows document formatting with easy-to-type markup. It is a popular format for writing on the web and is widely supported across applications.
TheBrain Markdown Reference
Markdown Visibility
Markdown formatting tags are generally hidden when you are interacting with the document in TheBrain but can be viewed and edited by altering the Notes.md file directly in a text editor. You can also copy text as raw markdown to paste into other applications that use it. If you paste raw markdown into TheBrain, it will be interpreted and formatted accordingly.
For convenience the following markdown can be typed directly into the editor starting with TheBrain 15:
- Headings
- Unordered lists
- Ordered lists
- Checkboxes (checked and unchecked)
- Horizontal rules
- Blockquotes
- Math expressions
- Inline code
- Highlights
Standard Markdown
TheBrain supports the following subset of Markdown:
A paragraph
Another paragraph.Paragraphs are simply a single run-on line of text with no breaks, followed by two line breaks between other paragraphs.
# TitleTitleDifferent levels of headings can be achieved by varying the number of
# characters at the start of a line from 1 to 6.
## SubtitleSubtitleSlightly smaller than a Title.
### HeadingHeadingSlightly smaller than a Subtitle.
#### Sub-headingSubheadingSmaller than a Heading.
> A blockquoteStart a line with
> to getA blockquote
*Italic* emphasisItalic emphasis
**Bold** emphasisBold emphasis
Inline `code` styleInline
code style (monospaced formatting)
* A bullet list
* Unordered items- A bullet list
- Unordered items
1. Numbered list
2. Ordered items- Numbered list
- Ordered items
[a link](https://en.
wikipedia.org/wiki/URL)This is a link to a Wikipedia page.
Links to thoughts (Local Thought URLs) are done in the same manner, with a
Links to thoughts (Local Thought URLs) are done in the same manner, with a
brain: link: [A thought](brain://...)
In the desktop and mobile clients, add images using copy-and-paste or drag-and-drop. Images can be resized from full width (100%) down to 5%. An image at 50% width is indicated by appending
#$width=50p$ to the image address.
Horizontal rule
---
Between paragraphsHorizontal rule
Between paragraphs
\* Escaped text* Escaped text
Use \ to escape single characters that would otherwise be interpreted as markdown formatting commands. In this example, the line would be a bulleted list if the backslash were not present.
Minor Changes to Markdown
Except for <br>, TheBrain ignores HTML tags and just treats them as plain text. TheBrain changes the meaning of the following Markdown characters:
First line
Another lineFirst line
Another line
Another line
Newline characters (when you press Enter/Return) are always respected whereas traditional Markdown would ignore single line breaks unless the line ended with space.
+ Done (checked)
- To do (unchecked)
* Normal bullet item- Done (checked)
- To do (unchecked)
- Normal bullet item
TheBrain Extensions to Markdown
TheBrain extends Markdown to add support for the following formatting:
==Highlighted== textHighlighted text
:-- Left justifiedLeft justified
Line justification is specified by adding :-- :-: or --: at the start of the line.
:-: CenteredCentered
--: Right justifiedRight justified
```
Code block
across multiple lines.
```Code block
across multiple lines.Code blocks are monospaced and ignore markdown formatting within them.
_{Underlined}_ textUnderlined text
The game is -{almost}- overThe game is almost over.
Add strikethrough to a word or phrase using the -{ and }- tags.
10^2 = 100102 = 100
Superscript is supported using ^ as a delimiter. These tags are slightly different in that they can be applied just at the start of the text to be affected and end automatically at punctuation or a space. To extend beyond punctuation, add a second ^ at the end also.
H~2~O is waterH2O is water.
Subscript is supported using ~ as a delimiter in a similar manner as superscript.
:{Red on yellow:(style=
"background-color:#ffff00;
color:#aa0000"):}: Red on yellow
Attributes for text foreground and background colors are applied by prefixing the style attribute with :( and ending it with :). The span indicating the text to which the attribute should apply is specified by surrounding it with :{ and }: . If an attribute is placed outside of a span, it will be applied to the entire line of text.
:{Text in a special font
:(style="font-family:
Lobster;font-size:150%"):}: Text in a special font
Attributes for font-family and font-size are also supported by TheBrain. Note that there is no UI for specifying font-size at this time.
$$\frac{n!}{k!(n-k)!} = \binom{n}{k}$$
Enclose a LaTeX expression within $$ tags to render math directly in the notes editor.
Provides support for: Simple algebraic equations, Fractions and continued fractions, Exponents and subscripts, Trigonometric formulae, Square roots and n-th roots, Calculus symbols (limits, derivatives, integrals), Big operators (e.g. product, sum), Big delimiters (using \left and \right), Greek alphabet, and much more...
TheBrain Table Extensions to Markdown
Similar to tables in GitHub Flavored Markdown with several powerful additions.
|Planet|Namesake|
|Mercury|Roman god of speed|
|Venus|Roman god of love|
|Earth|Variation of "the ground" in many languages|
|Mars|Roman god of war|| Planet | Namesake |
|---|---|
| Mercury | Roman god of speed |
| Venus | Roman god of love |
| Earth | Variation of "the ground" in many languages |
| Mars | Roman god of war |
- Each line of a table must start and end with
| - No dividing line after the header of
|---|---|should be added - The first line is treated as a header row. To hide the header row, use an empty line of two
|characters - Column widths are automatically determined based on the contents
|Item|Description|--: Price|
|Phone|Includes:{nl}* Holographic display{nl}* Telepathic UI|1,000.00|
|Case|Shock resistant hard shell|19.00|| Item | Description | Price |
|---|---|---|
| Phone | Includes:
| 1,000.00 |
| Case | Shock resistant hard shell | 19.00 |
- Multi-line cells are supported using
{nl}to denote new lines - Lines can utilize tags to include bullets, headings, etcetera
- Justify a cell using appropriate justification prefix at the start of the cell
- To justify a column, place the justification prefix in the header row
- To justify the table itself, place the justification prefix at the start of the header row, before the first
|
|Planet|Namesake|:(table="foreground-color:#fff8f8f2;background-color:#ff282c34;alt-background-color:#ff32363f;line-color:#ff454c5a;
first-row-foreground-color:#fff9264c;first-row-background-color:#ff212329;first-row-line-color:#ff373d48;
first-column-foreground-color:#ffa6e22e;first-column-background-color:#ff212329;first-column-line-color:#ff373d48;column-widths:-1,110"):
|Mercury|Roman god of speed|
|Venus|Roman god of love|
|Earth|Variation of "the ground" in many languages|
|Mars|Roman god of war|| Planet | Namesake |
|---|---|
| Mercury | Roman god of speed |
| Venus | Roman god of love |
| Earth | Variation of "the ground" in many languages |
| Mars | Roman god of war |
- Include a
:(table=""):tag at the end of a table header line to allow custom styling - Insert attributes such as
foreground-color:#ffffe050between the quotes, separated by semicolons - Hex values for each attribute are in AARRGGBB format
- Column widths can be assigned with the
column-widthsattribute - Column width values are in pixels and begin sequentially at the first column in the table.
-1represents a column that has no value assigned.