Liking cljdoc? Tell your friends :D

Tests

Tests require PostgreSQL running at localhost:5432.

Autorun Clojure tests: lein test-refresh

Run a graceful shutdown test: lein test :shutdown-test

Documentation

Project uses MkDocs with Cinder theme to generate documentation static site and Codox for API reference. Tasks are scripted using PyInvoke.

Serve site pages locally with automatic build (but it won't work for index page): mkdocs serve

Build only site pages: inv mkdocs

Build API reference into site folder: inv api

Build the whole site: inv site

Deploying

Deploy to Clojars: lein deploy clojars

Deploy site to gh-pages branch: ghp-import -p site

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close