Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: indicate support for markdown via myst-parser #937

Merged
merged 1 commit into from
Mar 30, 2024
Merged

doc: indicate support for markdown via myst-parser #937

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/features.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,20 @@ Type Notes

\newpage

Markdown support
----------------

This extension can support the rendering of Markdown content with the use of
Sphinx with the `MyST Parser`_. Most content can be translated to an
applicable Confluence storage format. However, not all content produced by
MyST Parser will work with this extension. Specifically, any directives that
generate HTML content or users who add raw HTML content to documents are not
accepted by default by this extension. This includes line breaks,
strikethroughs and more. Users may attempt to use the
``confluence_permit_raw_html`` option to help workaround select use cases, but
the use of the option is unsupported. When the option is enabled, published
content may not render as expected or may not be able to be published.

Extensions
----------

Expand Down Expand Up @@ -279,6 +293,7 @@ brings up another concern, feel free to bring up an issue:
| https://github.com/sphinx-contrib/confluencebuilder/issues


.. _MyST Parser: https://myst-parser.readthedocs.io/
.. _Sphinx's main source repository: https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext
.. _Sphinx: https://www.sphinx-doc.org/
.. _admonitions: https://docutils.sourceforge.io/docs/ref/rst/directives.html#admonitions
Expand Down
Loading