-
Notifications
You must be signed in to change notification settings - Fork 49
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Site plugin #68
Site plugin #68
Conversation
I don't love the name "microsite", which I think is associated with the sbt-microsites plugin. I was expecting to find Jekyll here and be grumpy about it. I do think having this will be a big win. |
This reverts commit 8f4cd65.
Ok, pending bikeshed of "microsite" (maybe just "site"?), I think this is in a reasonable place. It configures a basic mdoc/laika site with some Typelevely things and generates a CI job to build and publish the site. I'm hopeful we can use this to replace the Jekyll-based sites. The theme colors and other details can definitely be improved but that can happen in follow-up work and easily be propagated across all Typelevel projects. |
Updated the site at https://armanbilge.github.io/sbt-typelevel. |
This reverts commit 0e044d8.
I'd like to land this. Any feelings about the default, which publishes the site on every push? |
The problem with publishing on every push is that you can document features that are unreleased. The problem with publishing on tags is you need to do a patch release to correct a typo in your docs. There's no perfect default, so pick your poison. |
Yep, the age-old question. I like the publish-on-push default, making the following assumptions:
Note I'm making a distinction here between the site/mdocs vs the API scaladocs. API scaladocs should definitely not be published on every push, as they get out of sync with the latest release quickly. This plugin doesn't publish scaladocs, but I have future ideas for this. |
Towards #44.
I was curious, and couldn't help myself. This patches together a proof-of-concept microsite-plugin with a minimally configured Laika just to see what would happen. Here's what pops out: https://armanbilge.github.io/sbt-typelevel