Alchemy Markdown
Alchemy is based on the popular npm package markdown-it
(which uses the commonmark spec), extended by highlight-js
, markdown-it-anchor
, and markdown-it-table-of-contents
. Anything that works for them will work for Alchemy out of the box. You can add more markdown functionality in app.js
if you so choose.
Refer to the Commonmark spec for more capabilities.
Tables of contents
The following markdown:
[[toc]]
is rendered as:
Headings
# Large heading
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Rich Text
*italics*, **bold**
Blockquote
> Blockquote text
Lists
Ordered Lists:
1. item
2. item
3. item
...
Unordered Lists:
- item
- item
- item
...
Code
Inline code:
`inline-code`
Code blocks:
```
code block
```
Code blocks with languages:
```javascript
console.log('code blocks');
```
Links
[link text](url)
Images
![images](image url)
NOTE Images should be put in the theme/static
folder, and can be accessed at assets/static/
in your markdown.
Tables
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |