Our great sponsors
-
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
kotlin4example
Literate programming for Kotlin. Write markdown based documentation for your kotlin project with working examples.
-
-
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
-
-
Sure! The README links [1] to several installations used by large Open Source projects and companies. Some prominent examples:
- https://fastapi.tiangolo.com/
- https://crystal-lang.org/reference/
- https://docs.pi-hole.net/
- https://docs.openfaas.com/
- https://mozillafoundation.github.io/engineering-handbook/
- https://microsoft.github.io/code-with-engineering-playbook/
[1]: https://github.com/squidfunk/mkdocs-material#trusted-by-
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.
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
Sure! The README links [1] to several installations used by large Open Source projects and companies. Some prominent examples:
- https://fastapi.tiangolo.com/
- https://crystal-lang.org/reference/
- https://docs.pi-hole.net/
- https://docs.openfaas.com/
- https://mozillafoundation.github.io/engineering-handbook/
- https://microsoft.github.io/code-with-engineering-playbook/
[1]: https://github.com/squidfunk/mkdocs-material#trusted-by-
Sure! The README links [1] to several installations used by large Open Source projects and companies. Some prominent examples:
- https://fastapi.tiangolo.com/
- https://crystal-lang.org/reference/
- https://docs.pi-hole.net/
- https://docs.openfaas.com/
- https://mozillafoundation.github.io/engineering-handbook/
- https://microsoft.github.io/code-with-engineering-playbook/
[1]: https://github.com/squidfunk/mkdocs-material#trusted-by-
MkDocs Material is a popular tool for open source python projects. Here are some examples:
pydantic - https://pydantic-docs.helpmanual.io/
