Adding upstream version 0.11.12.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
f89f073565
commit
2f2c7f3767
146 changed files with 9553 additions and 0 deletions
56
docs/manual/markdown.md
Normal file
56
docs/manual/markdown.md
Normal file
|
@ -0,0 +1,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",
|
||||
]
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue