From 7372d4115abf472b09cb76f20e71d1226a9d5580 Mon Sep 17 00:00:00 2001 From: Liam Connors Date: Tue, 7 Jul 2026 11:51:05 -0400 Subject: [PATCH 1/4] update publishing with GitHub Actions section --- docs/publish-your-site.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/publish-your-site.md b/docs/publish-your-site.md index 099d180..d1fbdf0 100644 --- a/docs/publish-your-site.md +++ b/docs/publish-your-site.md @@ -19,12 +19,16 @@ charge and pretty easy to set up. [GitHub Pages]: https://pages.github.com/ -### with GitHub Actions +### Publish 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 repo 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 @@ -63,12 +67,13 @@ jobs: Zensical. When a new commit is pushed to the branch you are using for deployment -(e.g. `master` or `main`), the static site is automatically built and +(for example, `master` or `main` as shown in the earlier workflow), the static site is automatically built and deployed. Push your changes to see the workflow in action. Your documentation should shortly appear at `.github.io/`. [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 From 1d10e6c854f079d9d0303ac4fd48ca664df6438d Mon Sep 17 00:00:00 2001 From: Liam Connors Date: Tue, 7 Jul 2026 11:57:23 -0400 Subject: [PATCH 2/4] Update publish-your-site.md --- docs/publish-your-site.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/publish-your-site.md b/docs/publish-your-site.md index d1fbdf0..5757a74 100644 --- a/docs/publish-your-site.md +++ b/docs/publish-your-site.md @@ -67,7 +67,7 @@ jobs: Zensical. When a new commit is pushed to the branch you are using for deployment -(for example, `master` or `main` as shown in the earlier workflow), the static site is automatically built and +(e.g. `master` or `main`), the static site is automatically built and deployed. Push your changes to see the workflow in action. Your documentation should shortly appear at `.github.io/`. From 0f66a0a8603de5d79de7e48a82e611105e2cfe8c Mon Sep 17 00:00:00 2001 From: Liam Connors Date: Tue, 7 Jul 2026 11:58:09 -0400 Subject: [PATCH 3/4] Change wording --- docs/publish-your-site.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/publish-your-site.md b/docs/publish-your-site.md index 5757a74..5b2fee2 100644 --- a/docs/publish-your-site.md +++ b/docs/publish-your-site.md @@ -25,7 +25,7 @@ Using [GitHub Actions] you can automate the deployment of your project documentation on pushes to a specific branch in your repository. !!! note "Prerequisite" - GitHub Pages for your repo must be configured [to publish using GitHub Actions][configure publishing source]. + 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: From 15bd49ea6bae8857bf565b92ecb624df00f64441 Mon Sep 17 00:00:00 2001 From: Liam Connors Date: Tue, 7 Jul 2026 13:59:50 -0400 Subject: [PATCH 4/4] Change back to previous heading Signed-off-by: Liam Connors --- docs/publish-your-site.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/publish-your-site.md b/docs/publish-your-site.md index 5b2fee2..1e97d7e 100644 --- a/docs/publish-your-site.md +++ b/docs/publish-your-site.md @@ -19,7 +19,7 @@ charge and pretty easy to set up. [GitHub Pages]: https://pages.github.com/ -### Publish with GitHub Actions +### with GitHub Actions Using [GitHub Actions] you can automate the deployment of your project documentation on pushes to a specific branch in your repository.