iommi
mdBook
iommi | mdBook | |
---|---|---|
3 | 101 | |
628 | 16,754 | |
0.8% | 1.5% | |
9.1 | 8.6 | |
15 days ago | 5 days ago | |
Python | Rust | |
BSD 3-clause "New" or "Revised" License | Mozilla Public License 2.0 |
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.
iommi
-
Building a full Django project, starting with a single file
It's not really tied to manage.py no. And in any case that's a trivial 3 lines of code (plus imports, blank lines: https://github.com/iommirocks/iommi/blob/master/examples/man...).
I think you're overdramatizing 3 lines of code...
-
Beyond OpenAPI
It's all about the tooling. I wrote my own for iommi where the html output of some code gets saved in a defined place, and then the finished documentation page embeds that html in an iframe. It's not only WAY WAY easier to maintain than a bunch of screenshots, but I found a ton of issues with the documentation after I made it so it runs all the examples and I can look at the output.
example: https://docs.iommi.rocks/en/latest/cookbook_forms.html
corresponding documentation/tests: https://github.com/iommirocks/iommi/blob/master/docs/test_do...
my evil hack to get this working: https://github.com/iommirocks/iommi/blob/master/make_doc_rst... and https://github.com/iommirocks/iommi/blob/master/iommi/docs.p...
-
Markdown, Asciidoc, or reStructuredText – a tale of docs-as-code
is generated from this pytest source: https://github.com/TriOptima/iommi/blob/master/docs/test_doc...
Is that how rust documentation works?
mdBook
- Everything Curl
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
- FLaNK Stack for 4th of July
- MdBook – A command line tool to create books with Markdown
- MdBook Create book from Markdown files. Like Gitbook but implemented in Rust
What are some alternatives?
diataxis-documentation-framework - A systematic approach to creating better documentation.
gitbook - The open source frontend for GitBook doc sites
katt - KATT (Klarna API Testing Tool) is an HTTP-based API testing tool for Erlang.
MkDocs - Project documentation with Markdown.
pytest-doctestplus - Pytest plugin providing advanced doctest features
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
notebook
bookdown - Authoring Books and Technical Documents with R Markdown
eleventy-plugin-asciidoc - Eleventy plugin to add support for AsciiDoc.
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
httpyac - Command Line Interface for *.http and *.rest files. Connect with http, gRPC, WebSocket and MQTT
Docusaurus - Easy to maintain open source documentation websites.