You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
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>
2 years ago
..
_themes/searxng [interim fix] of sphinx-tabs and sphinx-jinja 2 years ago
admin Merge pull request #999 from return42/fix-doc-settings2 2 years ago
build-templates [doc] filtron.sh - install github.com/searxng/filtron 3 years ago
dev [docs] improve settings.yml documentation (admin/engines/settings) 2 years ago
src [doc] add some documentation about the limiter plugin (and redis) 2 years ago
user Sphinx doc: rename "User documentation" to "User Information" 2 years ago
utils [doc] filtron.sh - install github.com/searxng/filtron 3 years ago
conf.py [mod] replace Markdown parser mistletoe by markdown-it-py 2 years ago
index.rst [docs] move own-instance.rst out of docs/user 2 years ago
own-instance.rst [docs] move own-instance.rst out of docs/user 2 years ago