Test AsciiDoc and CommonMark code blocks found in articles and docstrings

• Status
• Rationale
• Docs
• Used to Test Docs In…​
• Versioning
• People
  • Contributors
  • Current Maintainers
• License

Alpha - early adopters and feedback welcome!

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

• User Guide

• Developer Guide

• 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.patch-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.

• patch indicates bug fixes - it is the number of commits in the repo.

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

Contributors

Current Maintainers

Copyright © 2021 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.