mkdocs-material
mike
Our great sponsors
mkdocs-material | mike | |
---|---|---|
92 | 2 | |
17,838 | 451 | |
- | - | |
9.8 | 7.4 | |
7 days ago | 28 days ago | |
HTML | Python | |
MIT License | BSD 3-clause "New" or "Revised" 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
-
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.
- Agora a nossa Megathread possui um novo visual!
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Wow, what is up with the material mkdocs theme (https://squidfunk.github.io/mkdocs-material/)? That's an extremely spiffy landing page, especially given that it's for a theme designed for a totally separate piece of software.
- Koji projekat na Githubu vas je odusevio u zadnje vreme?
-
MkDocs Publisher as an alternative for official Obsidian publish.
I was considering Pelican at some stage, but MkDocs has a great mobile friendly theme (Material for MkDocs) that is part of the dependencies. This theme and my previous experience in using MkDocs, gave me a clear answer what to use. There were also some other MkDocs plugins, that I was considering to use before I started to develop my bundle, but they were lacking in some elements (like plugin for wikilinks not working correctly for Obsidian links and one for callouts with small problems in embedded callouts, etc.). Finally, I didn't use those plugins, but they were good source to take a look at the code and get some inspiration, etc. (most of those plugins will mentioned in documentation in credits section, that is under construction). If you will ever have some features requests, just create an issue in git repo of the project. I'm open to suggestions how to extend functionality ot this project.
-
Site-wide Protest, Introducing leagueoflinux.org, and Poll for What to do Next with r/leagueoflinux
The site is built using MkDocs and themed with MkDocs-Material. Being markdown-based, porting over the webpages from the subreddit wiki was fairly painless, and on some pages I've already been able to extend their capabilities with in-line images, buttons and more modern special formatting tools.
-
Anyone know of a free dev docs like confluence?
Maybe something like https://squidfunk.github.io/mkdocs-material/ or https://www.bookstackapp.com/ ?
-
Public API documentation. What to use?
I use a combo of swagger and mkdocks: https://squidfunk.github.io/mkdocs-material/
-
Ask HN: What is the best product documentation you’ve ever seen?
Visual Studio App Center has excellent documentation: https://learn.microsoft.com/en-us/appcenter/distribution/cod.... It's comprehensive and well structured.
If you're looking for a system that looks as good, mkdocs (https://www.mkdocs.org/) with the mkdocs-material theme (https://squidfunk.github.io/mkdocs-material/) can get you quite close!
mike
-
where do you host your embedded docs?
I use MkDocs for generating the documentation website (using the Material theme) and host in on GitHub pages. For managing and hosting multiple versions, I use the Mike extension for MkDocs.
-
Technical documentation that just works
Thanks. This is an alternative vision compared with what I am doing, but it seems better. Especially the C4 model as basic philosophy, and then the supporting technology.
Pleas blog about this, it is very interesting to me.
Just to be sure: this is what you mean with Mike?
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
sphinx - The Sphinx documentation generator
MkDocs - Project documentation with Markdown.
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
Read the Docs - The source code that powers readthedocs.org
furo - A clean customizable documentation theme for Sphinx
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
river-runner - Uses USGS/MERIT Basin data to visualize the path of a rain droplet to its endpoint.
typedoc - Documentation generator for TypeScript projects.
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
VuePress - 📝 Minimalistic Vue-powered static site generator
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js