Skip to content

Commit ae333f6

Browse files
authored
Merge pull request #213 from typelevel/doc/unidoc-root-aggregate
Add note about adding unidocs to root aggregate
2 parents a4282ae + 1421548 commit ae333f6

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/site.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ For example, the sbt-typelevel `VERSION` is `@VERSION@` and `SNAPSHOT_VERSION` i
3434
If you generate your API documentation with [sbt-unidoc](https://github.com/sbt/sbt-unidoc), you can use the `TypelevelUnidocPlugin` to publish a Scaladoc-only artifact to Sonatype/Maven alongside your library artifacts. This makes it possible to browse your unidocs at [javadoc.io](https://www.javadoc.io/); for example, the sbt-typelevel [API docs](@API_URL@) are published like this.
3535

3636
```scala
37+
// Make sure to add to your root aggregate so it gets published!
3738
lazy val unidoc = project
3839
.in(file("unidoc"))
3940
.enablePlugins(TypelevelUnidocPlugin) // also enables the ScalaUnidocPlugin
@@ -44,4 +45,4 @@ lazy val unidoc = project
4445

4546
### How can I customize my website's appearance?
4647

47-
We refer you to the comprehensive [Laika manual](https://planet42.github.io/Laika/index.html) and specifically the [`laikaTheme` setting](https://planet42.github.io/Laika/0.18/02-running-laika/01-sbt-plugin.html#laikatheme-setting).
48+
We refer you to the comprehensive [Laika manual](https://planet42.github.io/Laika/index.html) and specifically the [`laikaTheme` setting](https://planet42.github.io/Laika/0.18/02-running-laika/01-sbt-plugin.html#laikatheme-setting).

0 commit comments

Comments
 (0)