Formatting
NumPad uses a subset of github-flavored markdown for text formatting. When you format text with markdown in the editor, the formatting is applied to lines that your cursor is not on. When your cursor is on a line with formatting, the text will be shown unformatted to make it easier to edit. When you export a document to HTML or PDF, the formatting is applied to the whole document, and some minor changes—discussed below—are made to improve the formatting.
Markdown formatting of NumPad calculations is ignored, but you can format the text hat comes after a calculation.
Headings
You can create headings with sizes h1
(biggest) to h6
(smallest) like so:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Inline Formatting
NumPad supports bold, italic, *bold italics and strikethrough
Format | Markdown Syntax | Example |
---|---|---|
Bold | **text** | bold text |
Italic | *text* | italic text |
Bold Italic | ***text*** | bold italic text |
Strikethrough | ~~text~~ |
Links
You can create a link by wrapping the text of the link in square brackets []
followed by the url of the link in parentheses ()
.
[my link](https://wikipedia.org)
Lists
There's support for ordered and unordered lists, though not yet any support for nested lists. In an unordered list, each item is preceded by a *
, a -
or a +
.
Unordered list:
* First item
* Second item
* Third item
- First item
- Second item
- Third item
+ First item
+ Second item
+ Third item
While ordered lists are prceded by a number followed by a .
.
Ordered list:
1. First item
2. Second item
3. Third item
Ordered lists are technically valid, even if you don't order the numbers properly, like so:
1. First item
1. Second item
1. Third item
or even
3. First item
2. Second item
1. Third item
In these cases the numbers will be represented as you type them when you view the document in the editor. But their ordering will be corrected when you export the document to HTML or PDF.
Blockquotes
Any line that starts with a >
followed by a space and then some text is formatted as a blockquote. Consecutive blockquote lines will be grouped together.
> We do these things not because they are easy, but because we thought they were going to be easy.
Or
> A quote that spans...
> multiple lines!
Horizontal Rules
Horizontal rules create a divider in the page. You can make them by starting a line with ---
. You can put whitespace after the dashes, but not any other characters.
---
Inline Codeblocks
You can make text appear in a monospace font by wrapping it in backticks ```.
A normal line with some `inline code` in the middle.
Escaping
If you want to show the literal representation of a character that would normally change the formatting, you can escape that character by preceding it with a \
, and the \
will be hidden in the final document so that you're just left with the character you want.
*this unescaped line will be italic*
\*this escaped line will just be wrapped in asterisks\*