instaunit
mkdocs-material
instaunit | mkdocs-material | |
---|---|---|
2 | 93 | |
22 | 18,342 | |
- | - | |
3.7 | 9.8 | |
2 months ago | 1 day ago | |
Go | HTML | |
- | 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.
instaunit
-
Stripe Open Sources Markdoc
Shameless plug: for REST APIs, I've written a tool called Instaunit which combines HTTP API integration tests with documentation generation, since these two things must always be maintained in lockstep.
It's got a ways to go before it generates output that looks as good as Stripe's documentation, but it makes it dead simple to create API documentation that's guaranteed to be in sync with your service, because it was generated by your tests when they ran.
https://github.com/instaunit/instaunit
-
Is there a recommended Test framework for Rest API?
Check out https://github.com/instaunit/instaunit. It lets you define the calls to be made and expected responses and will compare them semantically so you can match on expected fields without worrying about things like dates and IDs that you can't predict easily. It can also be used to generate documentation for your APIs which is awesome because your docs are then built from your tests so you know they are current and accurate.
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?
markdoc - A literate programming package for Stata which develops dynamic documents, slides, and help files in various formats
Docusaurus - Easy to maintain open source documentation websites.
wstest - go websocket client for unit testing of a websocket handler
sphinx - The Sphinx documentation generator
awesome-go-education - A curated list of awesome articles and resources for learning and practicing Go and its related technologies.
MkDocs - Project documentation with Markdown.
docs - Source code for the Streamlit Python library documentation
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
cryptogalaxy - Get any cryptocurrencies ticker and trade data in real time from multiple exchanges and then save it in multiple storage systems.
Read the Docs - The source code that powers readthedocs.org
burp - Somehow idiomatic Go service
mike - Manage multiple versions of your MkDocs-powered documentation via Git