Question 1

How do I exclude internal namespaces from Codox output?

Accepted Answer

Use the :namespaces option with regex patterns, such as #"^library\.(?!internal)" for negative lookahead, to filter out specific namespaces based on naming conventions. This allows fine-grained control over what appears in the generated documentation.

Question 2

Codox vs Marginalia: which is better for Clojure docs?

Accepted Answer

Codox excels at automated API documentation from metadata with HTML output and build tool integration, while Marginalia focuses on literate programming with interleaved code and comments in a single file. Choose Codox for structured API references and Marginalia for narrative-style documentation.

Question 3

How to add custom CSS styles to Codox documentation?

Accepted Answer

Create a custom theme by adding a theme.edn resource with :transforms for HTML modifications and :resources for CSS files, then specify it in the :themes configuration. Alternatively, use the :html {:transforms ...} option for direct Enlive-style transformations.

Question 4

Does Codox work with ClojureScript projects?

Accepted Answer

Yes, set :language :clojurescript in the configuration, and ensure source paths are correctly specified. However, note that some metadata features like :no-doc for namespaces may not be fully supported in ClojureScript as admitted in the README.

Question 5

Can I link Codox docs to my GitHub repository?

Accepted Answer

Yes, configure the :source-uri option with a template like "https://github.com/foo/bar/blob/{version}/{filepath}#L{line}" to generate clickable links from documentation back to the corresponding source code on GitHub.

Question 6

How to format docstrings with Markdown in Codox?

Accepted Answer

Set :doc/format :markdown in var metadata or globally in the :metadata configuration map. This enables Markdown rendering for docstrings, including support for code blocks, tables, and wikilink-style cross-references between vars.

codox

What is codox?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions