Liking cljdoc? Tell your friends :D


cljdoc Join chat Clojars Test

Test AsciiDoc and CommonMark code blocks found in articles and docstrings

While likely not malicious, sample code in docs could illustrate, for example, how to wipe a drive. So be deliberate and careful about what docs you run through test-doc-blocks.


Folks have been using test-doc-blocks for years without issue.


I wanted to make sure the code examples I provided in rewrite-clj v1 documentation do not mislead and function as expected for those who dare to try them. You might want the same for your library.

Used to Test Docs In…​

  • etaoin - Pure Clojure Webdriver protocol implementation

  • honeysql - Turn Clojure data structures into SQL

  • rewrite-clj - Rewrite Clojure Code and EDN!

  • test-doc-blocks - Test AsciiDoc and CommonMark code blocks found in articles and docstrings (meta, right?)

Have an update? Let us know!


Test-doc-block versioning scheme is: major.minor.release-test-qualifier

  • major increments when the API has been broken - something, as a rule, we’d like to avoid.

  • minor increments to convey significant new features have been added.

  • release starting with v1.1, the test-doc-blocks release count over the life of test-doc-blocks.

  • test-qualifier is absent for stable releases. Can be alpha, beta, rc1, etc.


Copyright © 2024 Lee Read, all rights reserved.

Distributed under the EPL License, same as Clojure. See LICENSE.

Based on concepts in @seancorfield’s readme, which is distributed under EPL v1.0 or later.

Can you improve this documentation? These fine people already did:
lread, GitHub Actions & Lee Read
Edit on GitHub

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

× close