summaryrefslogtreecommitdiffstats
path: root/docs/manual/markdown.md
blob: 63a38aac6ddb8b6442f7492bd6a1f41ac55daef4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
---
blogpost: true
date: Oct 10, 2020
author: Nabil Freij
location: World
category: Manual
language: English
---

# Markdown Support

ABlog can support markdown pages using [myst-parser](https://pypi.org/project/myst-parser/).
This page is a markdown file underneath.

You will need to do a few things to get setup.

1. Install [myst-parser](https://pypi.org/project/myst-parser/)
2. Add these options to your config, `conf.py`

```python
extensions = [
    ...
    "myst_parser",
    ...
]
myst_update_mathjax = False
```

Then use the new blogpost metadata format (with a slight twist):

```
---
blogpost: true
date: Oct 10, 2020
author: Nabil Freij
location: World
category: Manual
language: English
---
```

Notice here we do not have a ":" at the start since the markdown metadata format is different from rst.

Please be aware that adding "myst-parser" will mean it will read all markdown files and try to parse them.
You will need to use the following in your `conf.py` to prevent this:

```python
exclude_patterns = [
    "posts/*/.ipynb_checkpoints/*",
    ".github/*",
    ".history",
    "github_submodule/*",
    "LICENSE.md",
    "README.md",
]
```