mkdocs-material
furo
Our great sponsors
mkdocs-material | furo | |
---|---|---|
93 | 7 | |
18,123 | 2,446 | |
- | - | |
9.8 | 8.5 | |
9 days ago | 2 days ago | |
HTML | Sass | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
mkdocs-material
-
🚚 Building MVPs You Won’t Hate
Material Mk-Docs by Martin Donath works well if you prefer python.
-
The Open Source Sustainability Crisis
https://squidfunk.github.io/mkdocs-material/
I'm an 'outsider', but from from the outside the Material For MkDocs Project looks like a very well managed open source project.
Martin Donath's project uses a 'sponsorware' release strategy to generate donations.
From my vantage point it seems to be working pretty well.
- Release Mkdocs-Material-9.5.0
- Agora a nossa Megathread possui um novo visual!
-
Ask HN: What's the best place to start a newsletter?
I just recently went through this decision process. My aim is to write code and math oriented posts so I need good support for nice syntax highlighting (at least colored) and mathjax (preferable) or katex. Substack is the most popular newsletter platform but fails at these two criteria. I love how math and syntax highlighting (plus numerous other features) work in MkDocs Material, which recently added a Blog plugin.
I wanted to combine the best of both: Substack as an amazing email social network, and MkDocs Material’s awesome look. So I’ve gone with using Substack as the core platform which I use to manage subscribers, and use it to post either math/code-free posts or a short teasers pointing to my main blog site on MkDocs Material when I need to show math/code
- Material for MkDocs – Documentation that simply works
- Features tied to 'Piri Piri' funding goal
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
Changing CMS from Wordpress to ?
I've been migrating content to MKDocs (Material) over the last few months, so feel fairly qualified on this subject. It's somewhat limited in terms of navigation, but can probably handle 400-500 pages; you can see how navigation works in the link. Otherwise, it can handle most, if not all, the tasks you've listed.
- Kann man von Open Source leben? Interview mit Martin Donath, der von Open Source lebt.
furo
-
Can someone help me understand "documentation generators" and the purpose of Sphinx?
Sphinx has more and in my opinion better themes (especially the popular Furo them). I also think it's better for handling large and complex sites. It's way more extensible. That there are far more Sphinx users means that you're more likely to have community support if/when you run into issues.
-
Can you select themes for rustdoc?
My company uses sphinx, in particular the furo theme: https://github.com/pradyunsg/furo. I'd like to use something like this to start documenting our Rust repositories. Is this possible on stable?
-
[D] What JAX NN library to use?
On another note, what did you dislike in Sphinx ? I found it pretty easy to work with until now and there are quite nice themes, like Furo (https://github.com/pradyunsg/furo), which is actually pretty similar to your current docs theme. I used it recently for one of my projects (see https://francois-rozet.github.io/piqa/piqa.psnr.html).
-
New Sphinx theme
reminds me a lot of Furo which is used by big names such as urllib3, pip, attrs, psycopg3, black
- Furo: A clean customizable documentation theme for Sphinx
- Technical documentation that just works
-
Furo – A clean customizable documentation theme for Sphinx
This theme was created by one of the maintainers of pip, which is where I first saw it (https://pip.pypa.io/en/stable/). Here are some of the things I like about it:
- Well-chosen, proportionate font sizes and spacing.
- Table of contents sidebars for both the current page and the whole documentation site.
- Fully responsive: sidebars disappear in narrow windows or small screens, but can still be popped out.
- Clean color scheme with good contrast, and full support for dark mode (see screenshot at https://github.com/pradyunsg/furo/blob/main/README.md).
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
sphinx - The Sphinx documentation generator
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
MkDocs - Project documentation with Markdown.
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
vscode-theme-alabaster-dark - Dark version of alabaster ported from https://github.com/tonsky/sublime-scheme-alabaster
Read the Docs - The source code that powers readthedocs.org
PVEDiscordDark - A Discord-like dark theme for the Proxmox Web UI.
mike - Manage multiple versions of your MkDocs-powered documentation via Git
sphinx-immaterial - Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system