Sphinx myst

A markdown parser for sphinx, that injects additional restructuredtext functionality into the markdown syntax.

Documentation

official docs	https://myst-parser.readthedocs.io/en/latest/
syntax docs	https://myst-parser.readthedocs.io/en/latest/using/syntax.html
syntax extension docs	https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html

Configuration

# ${PACKAGE}/requirements.txt
sphinx
myst_parser

# ${PACKAGE}/source/conf.py

extensions = [
    'myst_parser',
]

Usage

Overview

# some title

Some `text`. 
An [external link](https://google.com).
An [internal](foo/note) link.


| foo | bar |
| --- | --- |
| a   | 1   |
| b   | 1   |


![family](img/my_family.png)

<!-- RST directives use triple quote syntax --->
```{code-block} python
def foo(*args, **kwargs):
    print('hello')
```

Directives

Apparently you can use either a sphinx inspired syntax, or a yaml inspired syntax.
I have not had success yet

```{toctree}
:maxdepth: 1
:caption: "Contents:"
:glob:

*
```

```{toctree}
---
maxdepth: 1
caption: 'Table of Contents:'
glob: 
---

*
```