diff --git a/docs/api/core_block_tokens.rst b/docs/api/core_block_tokens.rst index f64a400..62cfa99 100644 --- a/docs/api/core_block_tokens.rst +++ b/docs/api/core_block_tokens.rst @@ -14,7 +14,7 @@ These block tokens are defined in the - Description - Example - * - ATX Heading + * - (ATX)Heading - Level 1-6 headings, denoted by number of ``#`` - .. code-block:: md diff --git a/docs/api/extension_tokens.rst b/docs/api/extension_tokens.rst index ab08f3c..a0969a9 100644 --- a/docs/api/extension_tokens.rst +++ b/docs/api/extension_tokens.rst @@ -22,7 +22,7 @@ but are commonly implemented ~~some text~~ * - Math - - Dollar `$` enclosed math. Two ``$`` characters wrap multi-line math. + - Dollar ``$`` enclosed math. Two ``$`` characters wrap multi-line math. - .. code-block:: latex $a=1$ $b=2$ @@ -42,16 +42,18 @@ but are commonly implemented * - - Table - TableRow - TableCell - - Markdown table style, with pipe delimitation. + - Markdown table style, with pipe delimitation, + and (optional) colon specified alignment. - .. code-block:: md - | a | b | - | :--- | ---: | - | c | d | + | left | centre | right | + | :--- | :----: | ----: | + | a | b | c | * - - Footnote - FootReference - - A definition for a referencing footnote, that is placed at the bottom of the document. + - A definition for a referencing footnote, + that will usually be moved to the bottom of the document by a renderer. - .. code-block:: md Something that needs further explanation.[^ref] diff --git a/docs/api/index.rst b/docs/api/index.rst index 70ea525..9e14a47 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,7 +1,7 @@ .. _api/main: -mistletoe-EPB API -================= +Syntax API +========== .. toctree:: :maxdepth: 2 diff --git a/docs/index.md b/docs/index.md index c9e08ef..c1b3b35 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,11 +12,9 @@ Parsing Markdown into an abstract syntax tree also allows us to swap out renderers for different output formats, without touching any of the core components. -Remember to spell mistletoe in lowercase! - ```{note} This is a version of [mistletoe] maintained by the [Excutable Book Project (EBP)][ebp-link]. -It tracks the `myst` branch of [ExecutableBookProject/mistletoe](https://github.com/ExecutableBookProject/mistletoe) +It contains many improvements (see the `myst` branch of [ExecutableBookProject/mistletoe](https://github.com/ExecutableBookProject/mistletoe) for details) which eventually, it is hoped, will be merged into mistletoe itself. [ebp-link]: https://github.com/ExecutableBookProject @@ -94,8 +92,8 @@ using/contributing.md [commonmark-py]: https://github.com/rtfd/CommonMark-py [oilshell]: https://www.oilshell.org/blog/2018/02/14.html [commonmark]: https://spec.commonmark.org/ -[contrib]: https://github.com/miyuchina/mistletoe/tree/master/contrib -[scheme]: https://github.com/miyuchina/mistletoe/blob/dev/contrib/scheme.py +[contrib]: https://github.com/ExecutableBookProject/mistletoe-ebp/tree/master/contrib +[scheme]: https://github.com/ExecutableBookProject/mistletoe-ebp/blob/dev/contrib/scheme.py [example-392]: https://spec.commonmark.org/0.28/#example-392 [icon]: https://www.freepik.com [cc-by]: https://creativecommons.org/licenses/by/3.0/us/ diff --git a/docs/using/develop.md b/docs/using/develop.md index b46e7bd..b90abe4 100644 --- a/docs/using/develop.md +++ b/docs/using/develop.md @@ -1,6 +1,6 @@ (develop/intro)= -## Developer's Guide +## Developer Guide To understand the core tokens that mistletoe parses, take a look at: