From 02217926f94360638c14f9f36af3df355ae587ff Mon Sep 17 00:00:00 2001 From: Matias Capeletto Date: Fri, 27 Nov 2020 10:39:05 +0100 Subject: [PATCH] docs: add warning about .nojekyll --- docs/guide/deploy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/guide/deploy.md b/docs/guide/deploy.md index 588f12e8..2f10c3de 100644 --- 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`.