Skip to content

Commit

Permalink
📚 DOCS: Add link to sphinx-external-toc (#363)
Browse files Browse the repository at this point in the history
For use with `myst_commonmark_only`
  • Loading branch information
hukkinj1 authored Apr 30, 2021
1 parent cb0bca0 commit 4f8a39a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/using/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ To do so, use the keywords beginning `myst_`.
- Description
* - `myst_commonmark_only`
- `False`
- If `True` convert text as strict CommonMark (all options below are then ignored)
- If `True` convert text as strict CommonMark (all options below are then ignored). Note that strict CommonMark is unable to parse any directives, including the `toctree` directive, thus limiting MyST parser to single-page documentations. Use in conjunction with [sphinx-external-toc](https://github.com/executablebooks/sphinx-external-toc) Sphinx extension to counter this limitation.
* - `myst_disable_syntax`
- ()
- List of markdown syntax elements to disable, see the [markdown-it parser guide](markdown_it:using).
Expand Down

0 comments on commit 4f8a39a

Please sign in to comment.