mike
mkdocs-material
Our great sponsors
mike | mkdocs-material | |
---|---|---|
2 | 93 | |
467 | 18,269 | |
- | - | |
7.4 | 9.8 | |
25 days ago | 4 days ago | |
Python | HTML | |
BSD 3-clause "New" or "Revised" 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.
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?
https://github.com/jimporter/mike
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
https://squidfunk.github.io/mkdocs-material/
- 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.
What are some alternatives?
docs - The official Pi-hole documentation
Docusaurus - Easy to maintain open source documentation websites.
sphinx - The Sphinx documentation generator
autokeras - AutoML library for deep learning
MkDocs - Project documentation with Markdown.
furo - A clean customizable documentation theme for Sphinx
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
kotlin4example - Literate programming for Kotlin. Write markdown based documentation for your kotlin project with working examples.
Read the Docs - The source code that powers readthedocs.org
BookStack - A platform to create documentation/wiki content built with PHP & Laravel