Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
38 lines (25 sloc) 1.04 KB

cljdoc for Library Users

Finding Documentation

To find documentation use the search field on the cljdoc homepage or navigate to documentation directly by entering the appropriate URL.

URLs are formed like this:

# https://cljdoc.xyz/d/$group_id/$artifact_id/$version
https://cljdoc/.xyz/d/ring/ring-core/1.6.0

If we haven't built documentation for the requested project yet you'll see a page with a button to trigger a build. Builds usually don't take longer than 1-2 minutes.

Offline Docs

cljdoc allows users to download bundles of documentation for offline use. To do so just navigate to

# https://cljdoc.xyz/download/$group_id/$artifact_id/$version
https://cljdoc.xyz/download/reagent/reagent/0.8.1

or download the bundle using curl (note the -OJ flags):

curl -OJ https://cljdoc.xyz/download/reagent/reagent/0.8.1

Also see the Docsets page for more information.

Integrated support for tools like Dash and Zeal is underway.