Search code examples
clojuremarginalia

Clojure: Marginalia: Multi Page Documentation

Question

(run-marginalia {})

produces a single file, docs/uberdoc.html

I would prefer it to produce many files in docs/*, one per *.clj file

Motivation:

I really like marginalia. I have recently started using it, and it's causing me to want to write documentation, as impossible as that sounds.

However, I have this problem that whenever I write docs, and refresh, and reload uberdoc.html, I lose the part of the doc I was previously looking at. Thus, I would prefer a system where each *.clj file had it's on *.html file for documentation. Is this possible with marginalia 0.7.0?

Thanks!

Solution

  • There was a mutlidoc functionality in a previous version, but it is not at command line in the latest version. However, by running something like (multidoc! "./docs" (find-processable-file-paths "./src" #"\.clj$") {}) you should get directory of individual files.