Updated documentation with suggested improvements per review

Clarified "math" extension text, removed extraneous notes from "underline" and "highlight" extensions, clarified "tables" extension text.
isso-comments · Apr 29, 2024 · 0bbdf6e · 0bbdf6e
1 parent 5e95fdb
commit 0bbdf6e
Showing 1 changed file with 5 additions and 8 deletions.
diff --git a/docs/docs/reference/markdown-config.rst b/docs/docs/reference/markdown-config.rst
@@ -132,8 +132,9 @@ The following **additional options** are available:
 | 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!   |                           |
-| A library such as `MathJax <https://www.mathjax.org/>`_  |                           |
+| 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``     |
@@ -147,22 +148,18 @@ The following **additional options** are available:
 | page could clash due to duplicate links to footnotes.    |                           |
 +----------------------------------------------------------+---------------------------+
 | Use two ``=`` signs like ``==this==`` to highlight text. | ``highlight``             |
-| **Note:** The ``<mark>`` tag needs to be allowed under   |                           |
-| ``allowed-elements`` for this to work.                   |                           |
 +----------------------------------------------------------+---------------------------+
 | Text inside quotes gets a special "quote" class.         | ``quote``                 |
 | Perhaps useful for styling in CSS                        |                           |
 +----------------------------------------------------------+---------------------------+
 | 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, empty lines are required before and  |                           |
-| after the table for it to render properly.               |                           |
+| 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.                |                           |
-| **Note:** The ``<u>`` tag needs to be allowed under      |                           |
-| ``allowed-elements`` for this to work.                   |                           |
 +----------------------------------------------------------+---------------------------+
 
 .. todo:: ``no-intra-emphasis`` should be made default