Document markdown syntax for myst (#311)

Closes #310.
mcmtroffaes · Aug 22, 2022 · 05df1a3 · 05df1a3
1 parent e63f540
commit 05df1a3
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -17,6 +17,8 @@
 * Suppress LaTeX url commands in tooltips (see issue #305, reported by
   1kastner).
 
+* Document Markdown syntax for MyST (suggested by jacopok, see issue #310).
+
 2.4.2 (10 April 2022)
 ---------------------
 

diff --git a/doc/usage.rst b/doc/usage.rst
@@ -364,6 +364,21 @@ Roles and Directives
    created for references that do not yet have a footnote earlier in the
    document.
 
+Markdown Syntax Using MyST
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you use the MyST parser, all roles and directives are also available in
+Markdown syntax. For example:
+
+.. code-block:: markdown
+
+   See {cite:p}`1987:nelson` for an introduction to non-standard analysis.
+
+   ```{bibliography} references.bib
+   ```
+
+.. seealso:: https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html
+
 Advanced Features
 -----------------