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

Add notes to more accurately describe misaka library extensions #1017

Closed
wants to merge 2 commits into from
Closed

Add notes to more accurately describe misaka library extensions #1017

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34fac9c
docs: markdown-config: Clarify misaka config
mgc8 Apr 26, 2024
de92a62
Merge branch 'isso-comments:master' into patch-1
mgc8 Apr 29, 2024
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
21 changes: 16 additions & 5 deletions docs/docs/reference/markdown-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,15 @@ The following **additional options** are available:
+==========================================================+===========================+
| Ignore indented code blocks | ``disable-indented-code`` |
+----------------------------------------------------------+---------------------------+
| Parse inline LaTeX-style math blocks, such as | ``math`` |
| inline ``$equations$`` or display ``$$equations$$`` | |
| Ignore inline LaTeX-style math blocks, such as | ``math`` |
| inline ``$equations$`` or display ``$$equations$$``, | |
| allowing them to be processed separately with a | |
| JavaScript library. | |
| **Note:** This extension will *not* render equations | |
| or any form of math, it just marks them to be ignored by | |
| the markdown parser. A library such as | |
| `MathJax <https://www.mathjax.org/>`_ | |
| or `KaTeX <https://katex.org/>`_ is needed for that. | |
+----------------------------------------------------------+---------------------------+
| Normally, everything between two ``_underscores_`` would | ``no-intra-emphasis`` |
| be rendered with *emphasis*. This option disables | |
Expand All @@ -140,15 +147,19 @@ The following **additional options** are available:
| multiple footnotes by different commenters on the same | |
| page could clash due to duplicate links to footnotes. | |
+----------------------------------------------------------+---------------------------+
| Use two ``=`` signs like ``==this==`` to highlight text | ``highlight`` |
| Use two ``=`` signs like ``==this==`` to highlight text. | ``highlight`` |
+----------------------------------------------------------+---------------------------+
| Text inside quotes gets a special "quote" class. | ``quote`` |
| Perhaps useful for styling in CSS | |
+----------------------------------------------------------+---------------------------+
| Enable Markdown tables | ``tables`` |
| Enable Markdown tables. | ``tables`` |
| **Note:** The ``<tr>`` and all other ``<table>``-related | |
| tags need to be allowed under ``allowed-elements`` for | |
| this to work. Also, a table cannot be surrounded by | |
| anything other than blank lines to render properly. | |
+----------------------------------------------------------+---------------------------+
| Instead of ``_underscore`` resulting in *emphasis*, | ``underline`` |
| the resulting text will be... underlined | |
| the resulting text will be... underlined. | |
+----------------------------------------------------------+---------------------------+

.. todo:: ``no-intra-emphasis`` should be made default
Expand Down
Loading