docs: add warning about .nojekyll

5 years ago · 02217926f9
parent 8df41e4e2c
commit 02217926f9
1 changed files with 4 additions and 0 deletions
--- a/docs/guide/deploy.md
+++ b/docs/guide/deploy.md
@ -90,6 +90,10 @@ cd -
 You can also run the above script in your CI setup to enable automatic deployment on each push.
 :::

+::: warning
+GitHub pages have issues with the underscore in the dist `_assets` folder. To fix this an empty file name `.nojekyll` needs to be placed in the docs `public/`. See [Bypassing Jekyll on GitHub Pages](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/).
+:::
+
 ### GitHub Pages and Travis CI

 1. Set the correct `base` in `docs/.vitepress/config.js`.