diff --git a/docs/index.md b/docs/index.md index f85bffa5..fa1da2ef 100644 --- a/docs/index.md +++ b/docs/index.md @@ -102,7 +102,7 @@ ThisBuild / tlSitePublishBranch := Some("main") // deploy docs from this branch lazy val docs = project.in(file("site")).enablePlugins(TypelevelSitePlugin) ``` -Place your `.md` files in the `docs/` directory of your project. The site is generated using [mdoc](https://scalameta.org/mdoc/) and [Laika](https://planet42.github.io/Laika/) and published to the `gh-pages` branch on every push to the specified branch. Make sure to enable GitHub pages in your repo settings. +Place your `.md` files in the `docs/` directory of your project. The site is generated using [mdoc](https://scalameta.org/mdoc/) and [Laika](https://planet42.github.io/Laika/) and published to the `gh-pages` branch on every push to the specified branch. Make sure to enable GitHub pages in your repo settings. To preview locally, run `docs/mdoc` and then `docs/laikaPreview`. ## Customization @@ -143,7 +143,6 @@ Instead of using the super-plugins, for finer-grained control you can always add - `tlSitePublishBranch` (setting): The branch to publish the site from on every push. Set this to `None` if you only want to update the site on tag releases. (default: `main`) - `tlSiteApiUrl` (setting): URL to the API docs. (default: `None`) - `tlSiteHeliumConfig` (setting): the Laika Helium config. (default: how the sbt-typelevel site looks) - - To preview locally, run `docs/mdoc` and then [`docs/laikaPreview`](https://planet42.github.io/Laika/0.18/02-running-laika/01-sbt-plugin.html#using-the-preview-server). ### Dependency diagram