michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Disclaimer for Github pages / jekyll quirk (#1355)

Browse source 
* Added GH pages disclaimer

* Added changeset

* Reworded disclaimer

* Correct GH Pages casing

* Update deploy.md

Co-authored-by: Fred K. Schott <fkschott@gmail.com>
This commit is contained in:
Tc001 2021-09-14 01:39:45 +03:00 committed by GitHub
parent d7b6e54810
commit 6b8630c641
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/serious-fishes-lay.md Normal file
View file

@ -0,0 +1,5 @@
---
'docs': patch
---
Github pages disclaimer

2
docs/src/pages/guides/deploy.md
View file

@ -31,6 +31,8 @@ By default, the build output will be placed at `dist/`. You may deploy this `dis
## GitHub Pages
> **Warning:** By default, Github Pages will break the `_astro/` directory of your deployed website. To disable this behavior and fix your this issue, make sure that you use the `deploy.sh` script below or manually add an empty `.nojekyll` file to your `public/` site directory.
1. Set the correct `buildOptions.site` in `astro.config.mjs`.
1. Inside your project, create `deploy.sh` with the following content (uncommenting the appropriate lines), and run it to deploy: