Skip to content

Commit 97cabc6

Browse files
committed
Detail repo settings for site publishing
1 parent ca88a51 commit 97cabc6

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/site.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,14 @@ lazy val docs = project.in(file("site")).enablePlugins(TypelevelSitePlugin)
2121

2222
Place your `.md` files in the `docs/` directory of your project. To preview locally, run `docs/tlSitePreview`. This will start a preview server at http://localhost:4242.
2323

24-
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 repository settings.
24+
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.
25+
26+
You will also need to configure your repository settings:
27+
28+
1. Grant "Read and write" permissions to workflows. This enables them to push to the `gh-pages` branch.
29+
`https://github.com/{user}/{repo}/settings/actions`
30+
2. Set the GitHub pages source to the `/` (root) directory on the `gh-pages` branch.
31+
`https://github.com/{user}/{repo}/settings/pages`
2532

2633
### How can I include my project version on the website?
2734

0 commit comments

Comments
 (0)