A tool for generating API documentation from Clojure or ClojureScript source code.
Codox is a documentation tool for Clojure and ClojureScript that generates API documentation from source code metadata. It automates the creation of HTML documentation by analyzing namespaces and vars, ensuring documentation stays current with code changes. It solves the problem of manual documentation upkeep for Clojure projects.
Clojure and ClojureScript developers building libraries or applications who need automated, maintainable API documentation. It's particularly useful for open-source maintainers and teams prioritizing documentation quality.
Developers choose Codox for its deep integration with Clojure's metadata system and build tools, offering automated, accurate documentation generation. Its flexibility in output customization and source linking provides a professional documentation experience without manual effort.
Clojure documentation tool
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Extracts API documentation directly from Clojure/ClojureScript var and namespace metadata, ensuring accuracy and keeping docs synchronized with code changes automatically.
Integrates seamlessly with Leiningen, Boot, and deps.edn via plugins or aliases, fitting into existing Clojure development workflows without disruption.
Supports HTML transformations using Enlive and Hiccup, and allows theme creation with resources, enabling tailored documentation appearance and functionality.
Configurable links to source repositories like GitHub using template variables such as {filepath} and {line}, enhancing traceability and developer experience.
AOT-compiled namespaces lose metadata, forcing projects to avoid global AOT directives or use specialized profiles, which can complicate build configurations for deployments or releases.
Advanced features like HTML transformations and theme development require familiarity with Enlive and Hiccup libraries, adding complexity for teams without prior experience in these tools.
Version 0.9 introduced significant breaking changes in configuration options (e.g., renamed keys and tasks), requiring migration effort and potentially disrupting existing setups.