Liking cljdoc? Tell your friends :D

cljdoc-exerciser

This is a test project to exercise various cljdoc features and formatting.

It should be extended as the cljdoc community sees fit.

Building & Releasing

RunTo
bin/releaseto build and deploy to clojars
bin/prep_releaseto prep for release only, run this for local testing

Version scheme is defined in bin\generate_version

Some Tests

Images

Let's link to an image in a subdir with markdown syntax:

alt for test image 1

And again with html syntax:

alt for html test image 1

A little CommonMark

cljdoc recognizes clj, clojure and cljs language identifiers. From a formatting perspective they are all equivalent. Here we've specified cljs as our language:

(def v *clojurescript-version*)
(js/alert (str "Hello from ClojureScript v" v))

If we specify a language of clojure-repl we get repl-smart formatting:

user=> (+ 1 2 3 4)
10
user=> (* 1 2 3 4)
24
user=> (- 1 2 3 4)
-8

CommonMark is also supported in docstrings, have a look at cljdoc-exerciser namespace on cljdoc.org for some more examples.

Can you improve this documentation?Edit on GitHub

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

× close