vloothuis / cljdoc Goto Github PK

An effort to create a central documentation hub for the Clojure & ClojureScript ecosystem.

For Library Authors | Contributing | Website | ClojuTRE Talk

👋 Need help getting started? Say hi on Telegram, Twitter or Clojurians Slack in #cljdoc.

📹 I (Martin) gave a talk at ClojuTRE about cljdoc which is probably a good intro if you want to understand what cljdoc is and why it exists. If you prefer text, read on for the Rationale.

Publishing Clojure library documentation is an often manual and error prone process. Library authors who want to provide documentation need to set up tooling to create such documentation, host it and keep it updated. In combination all these steps introduce a significant amount of friction that often leads to there not being any HTML documentation at all. If there is documentation it's often only a matter of time until it's out of date with the latest release.

In short: Publishing documentation is hard. Harder than it has to be.

By fully automating the process of publishing documentation we can take a great burden from the shoulders of library maintainers and let them focus on shipping great libraries with great documentation.

A central place and consistent UI for all Clojure/Script library documentation will also make it easier for developers to find and work with documentation.

By centralizing this publishing process we can also build up a global understanding of the Clojure/Script ecosystem enabling many more interesting use-cases down the road.

• Provide an easy way to host library documentation for Clojure/Script library authors
• Deal with all the boring stuff: hosting, updating, keeping old versions around
• Build an ecosystem-encompassing database (+ API) of artifacts, namespaces and their contents.
• Support API documentation, articles and examples.
• Encourage the writing of more and better documentation.

To start the entire system, simply run:

./script/cljdoc run

After that the server will start under http://localhost:8000/. You can navigate to a projects documentation page like http://localhost:8000/d/bidi/bidi/2.1.3/ and request a build. This will analyze Bidi's source code locally and store the result. After that is done you can reload the page and view the documentation.

Logs can be viewed with tail -f log/cljdoc.log.

♻️ For a more REPL-driven workflow, you can start a REPL with clj, then load the system and move into its namespace:

(require '[cljdoc.server.system])
(in-ns 'cljdoc.server.system)

Now check the comment block at the end of cljdoc.server.system.

Tests: There is a small amount of tests which can be ran with clj -A:test.

I've been looking for an opportunity to use ADRs for some time, you can find them all in doc/adr/.

EPL-2.0 see LICENSE