kapshot
kotlinx-knit
| kapshot | kotlinx-knit | |
|---|---|---|
| 2 | 1 | |
| 69 | 299 | |
| - | 0.3% | |
| 4.0 | 5.0 | |
| 12 months ago | 5 months ago | |
| Kotlin | Kotlin | |
| MIT 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.
kapshot
-
Elixir Livebook is a secret weapon for documentation
The ability to execute sample code during documentation generation seems invaluable. Instead of being subject to rot, documentation turns into an executable test suite.
I've been working on something like this for Kotlin using a compiler plugin that allows code to access the source text of lambdas, functions and classes being executed. You write code that spits out markdown and captures its own source into code blocks.
https://github.com/mfwgenerics/kapshot
-
Is there a way to make this possible in Kotlin
Maybe try https://github.com/mfwgenerics/kapshot
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?
mdx - Execute code blocks inside your documentation
vega-lite - A concise grammar of interactive graphics, built on Vega.
livebook - Automate code & data workflows with interactive Elixir notebooks
explorer - Series (one-dimensional) and dataframes (two-dimensional) for fast and elegant data exploration in Elixir
bumblebee - Pre-trained Neural Network models in Axon (+ 🤗 Models integration)
notebooks - A collection of Livebook notebooks
hitchstory - Type-safe YAML integration tests. Tests that write your docs. Tests that rewrite themselves.
Docusaurus - Easy to maintain open source documentation websites.