mdx
kotlinx-knit
| mdx | kotlinx-knit | |
|---|---|---|
| 1 | 1 | |
| 263 | 298 | |
| 0.8% | 0.0% | |
| 6.5 | 5.0 | |
| about 2 months ago | 6 months ago | |
| OCaml | Kotlin | |
| ISC License | GNU General Public License v3.0 or later |
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.
mdx
-
Elixir Livebook is a secret weapon for documentation
This concept sounds quite a bit like the usage of .mdx files in OCaml. Those are markdown files which can load and execute OCaml code in them.
They are useful for unit testing code like libraries, providing usage examples for end-users (as well as the text format markdown usually supports) and testing it at the same time. Definitely a great idea for documentation, and one which I should use more of.
https://github.com/realworldocaml/mdx
kotlinx-knit
-
Elixir Livebook is a secret weapon for documentation
That sounds about right. The approach I'm working on won't allow you to embed runnable code in your docs. Instead, it requires you to write your documentation in Kotlin e.g. using a Markdown DSL where source code from the codebase can be included in the output. I'm working on a separate project to programmatically generate file trees and Docusaurus doc sites in code.
I'm not aware of anything exactly like Livebook in the Kotlin ecosystem but you might be interested in kotlinx-knit which takers a more incremental approach to executable documentation:
https://github.com/Kotlin/kotlinx-knit
What are some alternatives?
hitchstory - Type-safe YAML integration tests. Tests that write your docs. Tests that rewrite themselves.
vega-lite - A concise grammar of interactive graphics, built on Vega.
bumblebee - Pre-trained Neural Network models in Axon (+ 🤗 Models integration)
livebook - Automate code & data workflows with interactive Elixir notebooks
notebooks - A collection of Livebook notebooks
explorer - Series (one-dimensional) and dataframes (two-dimensional) for fast and elegant data exploration in Elixir
Docusaurus - Easy to maintain open source documentation websites.
kapshot - Kotlin Compiler Plugin for source capture