is a website building & hosting documentation for Clojure/Script libraries
Read the rationale or check out some examples: rum, kaocha, reitit.
cljdoc builds documentation for new releases that are pushed to Clojars within minutes. Ever forgot to update your docs after a release? No more.
Seamless integration of articles and tutorials from Markdown and Asciidoc source files.
Download documentation for any project in a zip file for easy offline use while travelling or swinging in your hammock. Supports Dash and Zeal.
In the future cljdoc may incorporate more than just API docs and articles. Specs and examples are high on the list.
Learn how to publish your docs to cljdoc, integrate tutorials and other material and add a badge to your project's Readme.Documentation for Library Authors →
Learn where to find documentation, how to download it for offline use and more.Documentation for Library Users →
Docs for every Clojure library available at a predictable, consistent location.
(str "https://cljdoc.org/d/" (:group-id your-project) "/" (:artifact-id your-project) "/" (:version your-project))
Platform-aware documentation, clearly indicating when things differ between Clojure & Clojurescript.
Documentation links are always tied to a specific version and old versions are kept available.
Open Source, so the community can work together to improve or even fork cljdoc.
cljdoc is created and maintained by its contributors.
Say hi in #cljdoc on Slack. Report issues on GitHub. Check out other Clojure resources.
Support cljdoc on OpenCollective.