Skip to content

Commit 3f67a89

Browse files
authored
using rst notes (#182)
1 parent 877b80c commit 3f67a89

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ MyST has the following main features:
2525
* **[A superset of CommonMark markdown][commonmark]**. Any CommonMark markdown
2626
(such as Jupyter Notebook markdown) is natively supported by the MyST parser.
2727

28+
You may use MyST markdown **in addition to** using reStructuredText in Sphinx.
2829
See {doc}`using/intro` to get started.
2930

3031
```{note}

docs/using/intro.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,16 @@ To use the MyST parser in Sphinx, simply add: `extensions = ["myst_parser"]` to
4040

4141
Naturally this site is generated with Sphinx and MyST!
4242

43+
```{admonition} You can use both MyST and reStructuredText
44+
:class: tip
45+
46+
Activating the MyST parser will simply *enable* parsing markdown files with MyST, and the rST
47+
parser that ships with Sphinx by default will still work the same way. You can have
48+
combinations of both markdown and rST files in your documentation, and Sphinx will
49+
choose the right parser based on each file's extension. Sphinx features
50+
like cross-references will work just fine between the pages.
51+
```
52+
4353
## How does MyST parser relate to Sphinx?
4454

4555
The Sphinx documentation engine supports a number of different input types. By default,

0 commit comments

Comments
 (0)