mkdocs-material
mkdocstrings
Our great sponsors
mkdocs-material | mkdocstrings | |
---|---|---|
93 | 9 | |
18,123 | 1,553 | |
- | 2.6% | |
9.8 | 8.3 | |
8 days ago | 13 days ago | |
HTML | Python | |
MIT License | ISC 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.
mkdocstrings
-
Starlite development updates January ’23
Mkdocs has the mkdocstrings plugin, offering limited automated API documentation capabilities. It is however nowhere near as capable as Sphinx' autodoc, missing granularity in its configuration, limited intersphinx-like cross-referencing support, and essential features like documentation of inherited members, or the ability to manually describe objects if needed.
-
what's a good documentation platform that you guys would recommend?
mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.
-
Stripe Open Sources Markdoc
Author of Materia for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.
- Mkdocstrings: Automatic Python documentation from sources, for MkDocs
- Technical documentation that just works
-
mkdocstrings: the "autodoc" plugin for MkDocs
Some time has passed since I first introduced mkdocstrings here on reddit. If you don't know what mkdocstrings is: it's the equivalent of the autodoc Sphinx extension, but for MkDocs, a Markdown static site generator. It works differently though, and supports multiple languages by design (not only Python). Someone actually wrote a very good handler for the Crystal language, and another user on GitHub recently expressed their interest for writing one for Go.
-
Python tutorials building large(r) projects
Write proper docstrings as you go along (every time you write a new class/method/function you can document what it’s doing as you’ll know why and what from the pattern you chose). Using a tool like mkdocstrings makes maintaining documentation for larger projects automatic.
-
[Project] mkgendocs - Generating documentation from Python docstrings for MkDocs
I learned of https://github.com/pawamoy/mkdocstrings recently. Is it similar ?
-
Python packages and plugins as namespace packages
A user of mkdocstrings wrote a Crystal handler for their own use-case. They asked on the Gitter channel if we could allow to load external handlers, so they don't have to fork the project and install the fork, but rather just install their lightweight package containing just the handler.
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
sphinx - The Sphinx documentation generator
pydocstyle - docstring style checker
MkDocs - Project documentation with Markdown.
furo - A clean customizable documentation theme for Sphinx
Read the Docs - The source code that powers readthedocs.org
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
mike - Manage multiple versions of your MkDocs-powered documentation via Git
pydantic - Data validation using Python type hints
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
mkdocs-markdownextradata-plugin - A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template