|
| 1 | +--- |
| 2 | +template: overrides/main.html |
| 3 | +--- |
| 4 | + |
| 5 | +# Alternatives |
| 6 | + |
| 7 | +There are tons of static site generators and themes out there and choosing the |
| 8 | +right one for your tech stack is a tough decision. If you're unsure if Material |
| 9 | +for MkDocs is the right solution for you, this section should help you evaluate |
| 10 | +alternative solutions. |
| 11 | + |
| 12 | +## Docusaurus |
| 13 | + |
| 14 | +[Docusaurus] by Facebook is a very popular documentation generator and a good |
| 15 | +choice if you or your company are already using [React] to build your site. |
| 16 | +It will generate a [single page application] which is fundamentally different |
| 17 | +from the site Material for MkDocs generates for you. |
| 18 | + |
| 19 | +__Advantages__ |
| 20 | + |
| 21 | +- Very powerful, customizable and extendable |
| 22 | +- Provides many components that aid in technical writing |
| 23 | +- Large and rich ecosystem, backed by Facebook |
| 24 | + |
| 25 | +__Challenges__ |
| 26 | + |
| 27 | +- High learning curve, JavaScript knowledge mandatory |
| 28 | +- JavaScript ecosystem is very volatile, rather high maintenance |
| 29 | +- More time necessary needed to get up and running |
| 30 | + |
| 31 | +While [Docusaurus] is one of the best choices when it comes to documentation |
| 32 | +sites that output a single page applications, there are many more solutions, |
| 33 | +including [Docz], [Gatsby], [Vuepress] and [Docsify] that approach |
| 34 | +this problem similarily. |
| 35 | + |
| 36 | + [Docusaurus]: https://docusaurus.io/ |
| 37 | + [React]: https://reactjs.org/ |
| 38 | + [single page application]: https://en.wikipedia.org/wiki/Single-page_application |
| 39 | + [Docz]: https://www.docz.site/ |
| 40 | + [Gatsby]: https://www.gatsbyjs.com/ |
| 41 | + [VuePress]: https://vuepress.vuejs.org/ |
| 42 | + [Docsify]: https://docsify.js.org/ |
| 43 | + |
| 44 | +## Jekyll |
| 45 | + |
| 46 | +[Jekyll] is probably one of the most mature and widespread static site |
| 47 | +generators and is written in [Ruby]. It is not specifically geared towards |
| 48 | +technical project documentation and has many themes to choose from, which |
| 49 | +can be challenging. |
| 50 | + |
| 51 | +__Advantages__ |
| 52 | + |
| 53 | +- Battle-tested, rich ecosystem, many themes to choose from |
| 54 | +- Brings great capabilities for blogging (permalinks, tags, etc.) |
| 55 | +- Generates a SEO-friendly site, similar to Material for MkDocs |
| 56 | + |
| 57 | +__Challenges__ |
| 58 | + |
| 59 | +- Not specifically geared towards technical project documentation |
| 60 | +- Limited Markdown capabilities, not as advanced as Python Markdown |
| 61 | +- More time necessary needed to get up and running |
| 62 | + |
| 63 | + [Jekyll]: https://jekyllrb.com/ |
| 64 | + [Ruby]: https://www.ruby-lang.org/de/ |
| 65 | + |
| 66 | +## Sphinx |
| 67 | + |
| 68 | +[Sphinx] is an alternative static site generator specifically greared towards |
| 69 | +generating reference documentation, offering powerful capabilities that are |
| 70 | +lacking in MkDocs. It uses [reStructured text], a format similar to Markdown, |
| 71 | +which some users find harder to use. |
| 72 | + |
| 73 | +__Advantages__ |
| 74 | + |
| 75 | +- Very powerful, customizable and extendable |
| 76 | +- Generates reference documentation from [Python Docstrings] |
| 77 | +- Large and rich ecosystem, used by many Python projects |
| 78 | + |
| 79 | +__Challenges__ |
| 80 | + |
| 81 | +- High learning curve, [reStructured text] syntax might be challenging |
| 82 | +- Search is less powerful than the one provided by MkDocs |
| 83 | +- More time necessary needed to get up and running |
| 84 | + |
| 85 | +[Sphinx Immaterial] is a great port of Material for MkDocs to Sphinx, as it |
| 86 | +follows the upstream repository closely. [Furo] is another great theme. |
| 87 | +Alternatively, [mkdocstrings] builds on top of Material for MkDocs to allow |
| 88 | +the generation of reference documentation. |
| 89 | + |
| 90 | + [Sphinx]: https://www.sphinx-doc.org/ |
| 91 | + [reStructured text]: https://en.wikipedia.org/wiki/ReStructuredText |
| 92 | + [Python Docstrings]: https://www.python.org/dev/peps/pep-0257/ |
| 93 | + [Sphinx Immaterial]: https://github.com/jbms/sphinx-immaterial |
| 94 | + [Furo]: https://pradyunsg.me/furo/ |
| 95 | + [mkdocstrings]: https://github.com/mkdocstrings/mkdocstrings |
| 96 | + |
| 97 | +## GitBook |
| 98 | + |
| 99 | +[GitBook] offers a hosted documentation solution that generates a beautiful and |
| 100 | +functional site from Markdown files in your GitHub repository. However, it was |
| 101 | +once Open Source, but turned into a closed source solution some time ago. |
| 102 | + |
| 103 | +__Advantages__ |
| 104 | + |
| 105 | +- Hosted solution, minimal technical knowledge required |
| 106 | +- Custom domains, authentication and other enterprise features |
| 107 | +- Great collaboration features for teams |
| 108 | + |
| 109 | +__Challenges__ |
| 110 | + |
| 111 | +- Closed source, not free for proprietary projects |
| 112 | +- Limited Markdown capabilities, not as advanced as Python Markdown |
| 113 | +- Many Open Source projects moved away from GitBook |
| 114 | + |
| 115 | +Many users switched from [GitBook] to Material for MkDocs, as they want to keep |
| 116 | +control and ownership of their documentation, favoring an Open Source solution. |
| 117 | + |
| 118 | + [GitBook]: https://www.gitbook.com/ |
0 commit comments