mike
kotlin4example
Our great sponsors
mike | kotlin4example | |
---|---|---|
2 | 1 | |
467 | 15 | |
- | - | |
7.4 | 6.0 | |
26 days ago | about 2 months ago | |
Python | Kotlin | |
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
kotlin4example
-
Technical documentation that just works
This tool seems like it is a nice markdown based CMS but I don't see too many features related to the more difficult parts of doing technical documentation. Like having working code samples.
I attempted a Kotlin centric documentation framework a while ago to address this: https://github.com/jillesvangurp/kotlin4example
I mainly use it to generate the documentation for my Elasticsearch Kotlin Client (jillesvangurp/es-kotlin-client). The idea there is that all examples and source samples are correctly compiling Kotlin code that I can get the output of when they run (e.g. a println). Running the tests, actually generates the documentation markdown. Using a dsl and multiline strings, I can mix lambda code blocks, markdown, or markdown inside files. For the lambda blocks, it figures out the source and line numbers using reflection. But it can also grab source samples based on comment markers. For bigger blobs of markdown, it's easier to grab the content from markdown files. For smaller sections of markdown, I can use inline multi line strings or a Kotlin DSL.
The main benefit of this is that my examples update as I change and refactor the code base. Also, since it runs as part of my tests, I know when examples break.
What are some alternatives?
mkdocs-material - Documentation that simply works
ltex-ls - LTeX Language Server: LSP language server for LanguageTool :mag::heavy_check_mark: with support for LaTeX :mortar_board:, Markdown :pencil:, and others
docs - The official Pi-hole documentation
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
sphinx - The Sphinx documentation generator
autokeras - AutoML library for deep learning
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
furo - A clean customizable documentation theme for Sphinx
crystal-book - Crystal reference with language specification, manuals and learning materials