diff options
| author |  Tc001 <55956895+Tc-001@users.noreply.github.com>
| 2021-09-14 01:39:45 +0300 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-09-13 15:39:45 -0700 |
| commit | 6b8630c641242b1d9086f5628bc1396122029a68 (patch) | |
| tree | 5e46db908ee025c7891971755058e22f12c01e88 | |
| parent | d7b6e5481062f3f4901483a14e26cf103a459596 (diff) | |
| download | astro-6b8630c641242b1d9086f5628bc1396122029a68.tar.gz astro-6b8630c641242b1d9086f5628bc1396122029a68.tar.zst astro-6b8630c641242b1d9086f5628bc1396122029a68.zip | |
Disclaimer for Github pages / jekyll quirk (#1355)
* Added GH pages disclaimer
* Added changeset
* Reworded disclaimer
* Correct GH Pages casing
* Update deploy.md
Co-authored-by: Fred K. Schott <fkschott@gmail.com>
| -rw-r--r-- | .changeset/serious-fishes-lay.md | 5 | ||||
| -rw-r--r-- | docs/src/pages/guides/deploy.md | 2 |
2 files changed, 7 insertions, 0 deletions
diff --git a/.changeset/serious-fishes-lay.md b/.changeset/serious-fishes-lay.md new file mode 100644 index 000000000..c619513dc --- /dev/null +++ b/.changeset/serious-fishes-lay.md @@ -0,0 +1,5 @@ +--- +'docs': patch +--- + +Github pages disclaimer diff --git a/docs/src/pages/guides/deploy.md b/docs/src/pages/guides/deploy.md index e5e3db1c9..de98b9e3f 100644 --- a/docs/src/pages/guides/deploy.md +++ b/docs/src/pages/guides/deploy.md @@ -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: |