Skip to content

Update GitHub Actions info on publish page #147

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.

Sign up for GitHub

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

Merged
alexvoss merged 4 commits into from
Jul 7, 2026
Merged

Update GitHub Actions info on publish page #147

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7372d41
update publishing with GitHub Actions section
LiamConnors Jul 7, 2026
1d10e6c
Update publish-your-site.md
LiamConnors Jul 7, 2026
0f66a0a
Change wording
LiamConnors Jul 7, 2026
15bd49e
Change back to previous heading
LiamConnors Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/publish-your-site.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,13 @@ charge and pretty easy to set up.
### with GitHub Actions

Using [GitHub Actions] you can automate the deployment of your project
documentation. At the root of your repository, create a new GitHub Actions
workflow, e.g. `.github/workflows/docs.yml`, and copy and paste the following
contents:
documentation on pushes to a specific branch in your repository.

!!! note "Prerequisite"
GitHub Pages for your repository must be configured [to publish using GitHub Actions][configure publishing source].

If you created your site with `zensical new`, a publishing workflow was already created for your project in `.github/workflows/docs.yml`. If you don't already have this workflow, create a new GitHub Actions workflow at the root of your
repository (e.g. `.github/workflows/docs.yml`) with the following contents:

``` yaml
name: Documentation
Expand Down Expand Up @@ -69,6 +73,7 @@ deployed. Push your changes to see the workflow in action.
Your documentation should shortly appear at `<username>.github.io/<repository>`.

[GitHub Actions]: https://github.com/features/actions
[configure publishing source]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow

## GitLab Pages

Expand Down