Skip to content

Commit 63f249e

Browse files
committed
Add GitHub Pages config section to README
1 parent cca5101 commit 63f249e

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,23 @@ git remote add origin https://github.com/<yourname>/<repo-name>.git
144144
[pandoc markdown]: <https://pandoc.org/MANUAL.html#pandocs-markdown>
145145
[my post about it]: <https://benjaminwuethrich.dev/2020-05-04-everything-pandoc-markdown.html>
146146

147+
### GitHub Pages configuration
148+
149+
To deploy via GitHub Pages, configure your repository accordingly:
150+
151+
1. Go to *Settings* > *Pages* (URL looks like
152+
`https://github.com/USER/REPO/settings/pages`)
153+
2. In *Build and deployment* > *Source*, pick "Deploy from branch"
154+
3. In *Build and deployment* > *Branch*, pick your default branch (often
155+
`main`) and `/docs` as the folder
156+
157+
This uses the default build and deploy method for GitHub Pages under the hood.
158+
`pbb` creates a [`.nojekyll`] file in the `docs` directory, which prevents
159+
[Jekyll] from being run and instead just deploys the contents as they are.
160+
161+
[`.nojekyll`]: <https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#troubleshooting-publishing-from-a-branch>
162+
[jekyll]: <https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll>
163+
147164
### Table of contents
148165

149166
To get a table of contents for a post, set `toc` to `true` in the YAML front

0 commit comments

Comments
 (0)