From 0bbdf6e61b2a7af19ab1daa7e01f01da540cd9fe Mon Sep 17 00:00:00 2001 From: Mihnea-Costin Grigore Date: Mon, 29 Apr 2024 19:35:44 +0200 Subject: [PATCH] Updated documentation with suggested improvements per review Clarified "math" extension text, removed extraneous notes from "underline" and "highlight" extensions, clarified "tables" extension text. --- docs/docs/reference/markdown-config.rst | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/docs/reference/markdown-config.rst b/docs/docs/reference/markdown-config.rst index a34570be..c91c3912 100644 --- 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 `_ | | +| or any form of math, it just marks them to be ignored by | | +| the markdown parser. A library such as | | +| `MathJax `_ | | | or `KaTeX `_ is needed for that. | | +----------------------------------------------------------+---------------------------+ | Normally, everything between two ``_underscores_`` would | ``no-intra-emphasis`` | @@ -147,8 +148,6 @@ 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 ```` 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 | | @@ -156,13 +155,11 @@ The following **additional options** are available: | Enable Markdown tables. | ``tables`` | | **Note:** The ```` and all other ````-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 ```` tag needs to be allowed under | | -| ``allowed-elements`` for this to work. | | +----------------------------------------------------------+---------------------------+ .. todo:: ``no-intra-emphasis`` should be made default