Skip to content
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

Add missing step to Deploy an Eleventy project to GitHub pages mini-tutorial #1767

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add missing step to Deploy an Eleventy project to GitHub pages mini-tutorial #1767

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions src/docs/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,15 @@ Includes persisted cache across builds. Using [`peaceiris/actions-gh-pages`](htt
<ol>
<li>Go to your repository’s Settings on GitHub.</li>
<li>In the GitHub Pages section change:<ul><li>Source: <code>Deploy from a branch</code></li><li>Branch: <code>gh-pages/(root)</code></li></ul></li>
<li>Add "build-ghpages" command to your <details><summary><code>package.json</code> scripts section</summary>

```json
"scripts": {
"build-ghpages": "npx @11ty/eleventy --pathprefix=/your-repo-name/",
}
```

</details></li>
<li>Create a new GitHub workflow file in <details><summary><code>.github/workflows/deploy-to-ghpages.yml</code></summary>

{% raw %}
Expand Down