1
0
mirror of https://github.com/searxng/searxng.git synced 2024-11-22 20:17:45 +01:00
searxng/docs
Markus Heiser 9215281232 [mod] replace Markdown parser mistletoe by markdown-it-py
There are several reasons why we should prefer markdown-it-py over mistletoe:

- Get identical rendering results in SearXNG's `/info` pages and the SearXNG's
  project documentation which is build by Sphinx-doc.

  In the Sphinx-doc we use the MyST parser to render Markdown and the MyST
  parser itself is built on top of the markdown-it-py package.

- markdown-it-py has a typographer that supports *replacements*
  and *smartquotes* (e.g. em-dash, copyright, ellipsis, ...) [1]

- markdown-it-py is much more flexible compared to mistletoe [2]

- markdown-it-py is the fastest CommonMark compliant parser in python [3]

[1] https://markdown-it-py.readthedocs.io/en/latest/using.html#typographic-components
[2] https://markdown-it-py.readthedocs.io/en/latest/plugins.html
[3] https://markdown-it-py.readthedocs.io/en/latest/other.html#performance

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-04-06 15:49:50 +02:00
..
_themes/searxng [interim fix] of sphinx-tabs and sphinx-jinja 2022-03-12 14:25:34 +01:00
admin Merge pull request #999 from return42/fix-doc-settings2 2022-03-26 17:09:07 +01:00
build-templates [doc] filtron.sh - install github.com/searxng/filtron 2021-11-21 17:13:34 +01:00
dev [docs] improve settings.yml documentation (admin/engines/settings) 2022-03-21 08:48:06 +01:00
src [doc] add some documentation about the limiter plugin (and redis) 2022-03-25 11:26:10 +01:00
user Sphinx doc: rename "User documentation" to "User Information" 2022-03-16 22:26:36 +01:00
utils [doc] filtron.sh - install github.com/searxng/filtron 2021-11-21 17:13:34 +01:00
conf.py [mod] replace Markdown parser mistletoe by markdown-it-py 2022-04-06 15:49:50 +02:00
index.rst [docs] move own-instance.rst out of docs/user 2022-03-07 08:29:00 +01:00
own-instance.rst [docs] move own-instance.rst out of docs/user 2022-03-07 08:29:00 +01:00