Documentation fixes.

This commit is contained in:
Franco Masotti 2022-04-03 00:23:50 +02:00
parent 264067c785
commit 74bb865b9e
Signed by: frnmst
GPG Key ID: 24116ED85666780A
4 changed files with 21 additions and 5 deletions

BIN
docs/assets/orange.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 216 B

View File

@ -13,7 +13,11 @@ Compatibility table
:width: 16
:height: 16
.. |partial| image:: assets/yellow.png
.. |partial| image:: assets/orange.png
:width: 16
:height: 16
.. |good| image:: assets/yellow.png
:width: 16
:height: 16
@ -35,6 +39,7 @@ Color Meaning
|none| none
|low| low
|partial| partial
|good| good
|most| most
|full| full
============ ===========
@ -46,8 +51,8 @@ Status
Parser Status Alias of Supported parser version Source
======================= ===================== ============ ======================================================================================================== =============================================
``cmark`` |most| Version 0.30 (2021-06-19) https://github.com/commonmark/cmark
``commonmarker`` |most| ``github`` https://github.com/gjtorikian/commonmarker
``github`` |most| Version 0.29-gfm (2019-04-06) https://github.com/github/cmark-gfm
``commonmarker`` |good| ``github`` https://github.com/gjtorikian/commonmarker
``github`` |good| Version 0.29-gfm (2019-04-06) https://github.com/github/cmark-gfm
``goldmark`` |most| ``cmark`` https://github.com/yuin/goldmark
``gitlab`` |partial| Latest unknown version https://docs.gitlab.com/ee/user/markdown.html
``redcarpet`` |low| `Redcarpet v3.5.0 <https://github.com/vmg/redcarpet/tree/6270d6b4ab6b46ee6bb57a6c0e4b2377c01780ae>`_ https://github.com/vmg/redcarpet

View File

@ -31,8 +31,10 @@ Supported markdown parsers
- uses a forked version of ``cmark`` with some added extensions.
This language specification is called GitHub Flavored Markdown.
- there are subtle differences such as
the disallowed raw HTML extension which affects md-toc.
- there are subtle differences that affect md-toc such as
- the disallowed raw HTML extension which affects md-toc
- emphasis processing
- ``gitlab``:

View File

@ -103,3 +103,12 @@ from the original cmark source with some differences:
- https://rosettacode.org/wiki/String_length#Python
- https://docs.python.org/3/howto/unicode.html#comparing-strings
As of the release md-toc 8.1.2, cmark-gfm is still at version 0.29. Moreover, certain
code sections used in the emphasis processing are not the same of cmark 0.29. See
this one for example:
- https://github.com/github/cmark-gfm/blob/0.29.0.gfm.3/src/inlines.c#L639-L654
- https://github.com/commonmark/cmark/blob/0.29.0/src/inlines.c#L615-L621
For the moment md-toc uses the original cmark source only as reference for emphasis processing.