3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-07 06:07:42 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2): mention about disabling Jekyll when using GitHub pages (#2340)

Browse source 
* docs(v2): add docs for disabling jekyll when using gh pages

* Change to admonition

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
This commit is contained in:
Amila Welihinda 2020-02-27 17:51:15 -08:00 • committed by GitHub
parent baed4faa24
commit 15e6763089
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
website/docs/deployment.md
View file

@ -67,6 +67,12 @@ module.exports = {
} }
``` ```
:::tip
By default, GitHub Pages runs published files through [Jekyll](https://jekyllrb.com/). Since Jekyll will discard any files that begin with `_`, it is recommended that you disable Jekyll by adding an empty file named `.nojekyll` file to your `static` directory.
:::
### Environment settings ### Environment settings
Specify the Git user as an environment variable. Specify the Git user as an environment variable.