= lread.test-doc-blocks :project-coords: lread/test-doc-blocks :deploy-coords: com.github.{project-coords} ifdef::env-github[] :tip-caption: :bulb: :note-caption: :information_source: :important-caption: :heavy_exclamation_mark: :caution-caption: :fire: :warning-caption: :warning: endif::[] :toc: macro

https://cljdoc.org/d/{deploy-coords}/CURRENT[image:https://cljdoc.org/badge/{deploy-coords}[cljdoc]] https://clojurians.slack.com/archives/C02NSHB3T0A[image:https://img.shields.io/badge/slack-join_chat-brightgreen.svg[Join chat]] https://clojars.org/{deploy-coords}[image:https://img.shields.io/clojars/v/{deploy-coords}.svg[Clojars]] https://github.com/{project-coords}/actions?query=workflow%3ATest[image:https://github.com/{project-coords}/workflows/Test/badge.svg[Test]]

Test AsciiDoc and CommonMark code blocks found in articles and docstrings

[CAUTION]

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.

toc::[]

== Status

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

== Rationale 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.

== Docs

• link:doc/01-user-guide.adoc[User Guide]
• link:doc/02-developer-guide.adoc[Developer Guide]

== Used to Test Docs In...

• https://github.com/clj-commons/etaoin[etaoin] - Pure Clojure Webdriver protocol implementation
• https://github.com/seancorfield/honeysql[honeysql] - Turn Clojure data structures into SQL
• https://github.com/clj-commons/rewrite-clj[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!

== Versioning

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.

== People

=== Contributors // Contributors updated by script, do not edit // AUTO-GENERATED:CONTRIBUTORS-START :imagesdir: ./doc/generated/contributors []

image:seancorfield.png[seancorfield,width=273,link="https://github.com/seancorfield"] image:MIJOTHY.png[MIJOTHY,width=273,link="https://github.com/MIJOTHY"] image:borkdude.png[borkdude,width=273,link="https://github.com/borkdude"] image:genmeblog.png[genmeblog,width=273,link="https://github.com/genmeblog"] image:holyjak.png[holyjak,width=273,link="https://github.com/holyjak"] image:PEZ.png[PEZ,width=273,link="https://github.com/PEZ"] image:SevereOverfl0w.png[SevereOverfl0w,width=273,link="https://github.com/SevereOverfl0w"] image:sogaiu.png[sogaiu,width=273,link="https://github.com/sogaiu"] image:uochan.png[uochan,width=273,link="https://github.com/uochan"]

// AUTO-GENERATED:CONTRIBUTORS-END

=== Current Maintainers // Maintainers updated by script, do not edit // AUTO-GENERATED:MAINTAINERS-START :imagesdir: ./doc/generated/contributors []

image:lread.png[lread,width=273,link="https://github.com/lread"]

// AUTO-GENERATED:MAINTAINERS-END

== License Copyright © 2024 Lee Read, all rights reserved.

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

Based on concepts in @seancorfield's https://github.com/seancorfield/readme[readme], which is distributed under EPL v1.0 or later.