Ultra-lightweight literate programming tool for Clojure and ClojureScript that generates side-by-side source documentation.
Marginalia is an ultra-lightweight literate programming tool for Clojure and ClojureScript that generates side-by-side documentation from source code. It parses code and aligns comments and docstrings with the corresponding source, producing HTML output for easy code exploration. The tool helps developers create readable, narrative-style documentation directly from their codebase.
Clojure and ClojureScript developers who want to generate accessible, formatted documentation from their source code without heavy tooling. It's particularly useful for teams prioritizing code readability and documentation clarity.
Developers choose Marginalia for its simplicity, lightweight design, and seamless integration with Clojure build tools like Leiningen and deps.edn. Its side-by-side output format provides an intuitive way to review code and documentation together, inspired by docco but tailored for the Clojure ecosystem.
Ultra-lightweight literate programming for clojure inspired by docco
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Generates HTML with source code and aligned comments/docstrings, inspired by docco, as highlighted in the README's description and usage examples.
Works seamlessly with Leiningen, deps.edn, and Maven via plugins, offering flexible workflows as detailed in the Usage section.
Supports customization of output directory, file naming, CSS/JS resources, and namespace separation through command-line flags, per the invocation table.
Can lift inline `;;` comments to the top of forms for better flow, with options to exclude them from source display, as noted in the flag descriptions.
Admits in the notes that it's not for classical literate programming, lacking out-of-order reassembly, which limits advanced narrative structuring.
Requires the zi plugin and extensive XML configuration in pom.xml and settings.xml, making integration more cumbersome compared to Leiningen or deps.edn.
Produces only static files without built-in interactive features like search or live updates, which may not suit teams needing dynamic documentation.