03-faq.adoc

Frequently Asked Questions

Documentation

What is the meaning of the ^:no-doc metadata?

Our goal is to produce documentation for users of rewrite-clj. As such we only want to document public APIs.

^:no-doc is a signal to cljdoc that source code should not be included in generated documentation. This metadata convention was introduced by codox.

What the markdown?

Stand alone articles are written up in AsciiDoc.

1. it is a richer markup language than GitHub markdown.

2. is supported by cljdoc.

Our docstrings sometimes take advantage of CommonMark which is supported by cljdoc for docstrings. GitHub uses CommonMark as part of of its markdown solution.