OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-05-07 11:21:35 +02:00
parent 8beda2bfe1
commit eab1b319f5
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/alternatives.md
View File

@ -82,15 +82,20 @@ __Challenges__
- Search is less powerful than the one provided by MkDocs - Search is less powerful than the one provided by MkDocs
- More time needed to get up and running - More time needed to get up and running
[Sphinx Immaterial] is a great port of Material for MkDocs to Sphinx, as it If you want to chose Sphinx over MkDocs, you might want to check out
follows the upstream repository closely. [Furo] is another great theme. [Immaterial], an actively maintained Sphinx port of Material for MkDocs.
Alternatively, [mkdocstrings] builds on top of MkDocs to allow However, be warned that the search experience is pretty far from what Material
the generation of reference documentation. for MkDocs offers, mainly due to limitations of Sphinx.
If you want the best of both worlds, you should give [mkdocstrings] a try – a
popular framework building on top of MkDocs that generates documentation from
sources, similar to what Sphinx offers. The project is still young, but already
closed many gaps between MkDocs and Sphinx.
[Sphinx]: https://www.sphinx-doc.org/ [Sphinx]: https://www.sphinx-doc.org/
[reStructured text]: https://en.wikipedia.org/wiki/ReStructuredText [reStructured text]: https://en.wikipedia.org/wiki/ReStructuredText
[Python Docstrings]: https://www.python.org/dev/peps/pep-0257/ [Python Docstrings]: https://www.python.org/dev/peps/pep-0257/
[Sphinx Immaterial]: https://github.com/jbms/sphinx-immaterial [Immaterial]: https://github.com/jbms/sphinx-immaterial
[Furo]: https://pradyunsg.me/furo/ [Furo]: https://pradyunsg.me/furo/
[mkdocstrings]: https://github.com/mkdocstrings/mkdocstrings [mkdocstrings]: https://github.com/mkdocstrings/mkdocstrings