Mill Site

[Quafadas]

I spent a little time, writing a plugin which aims to make generating static library documentation websites with mill, easier.

https://github.com/Quafadas/millSite
https://quafadas.github.io/millSite/docs/

My motivation, was that I found I really like new scaladoc. I like seeing the API I'm trying to foist off on someone, right next to the documentation I'm writing for it. However, using mills built in docJar task,

• incremental change was rather slow, for a non-trivial project.
• The default delete -> recreate loop more or less breaks any form of live reload by construction.
• I keep re-creating the same parameters for the doc task across different projects
• I wanted mdoc as a pre-processor (even after I found about the snippet compiler)

This goes after all those problems, plus some other things.

It's my first mill plugin though. Plus, I'm not actually that familiar with scaladoc, so there may well be some rough edges. I've found it works well enough for my own needs, thus far. Although the motivating project isn't public, I've been testing it in a few (unimportant!) public places, so you could peek at the results here.

https://quafadas.github.io/vecxt/docs/
https://quafadas.github.io/scautable/docs/

A random fork of Pprint to mess around with it, too;
https://quafadas.github.io/PPrint/docs/
https://quafadas.github.io/PPrint/docs/index.html

Feedback welcomed - if you're brave enough to give it a go, don't be shy!