From 15e6763089dd27acd6f84709defdde7bb81f99bf Mon Sep 17 00:00:00 2001
From: Amila Welihinda <amilajack@gmail.com>
Date: Thu, 27 Feb 2020 17:51:15 -0800
Subject: [PATCH] docs(v2): mention about disabling Jekyll when using GitHub
 pages (#2340)

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

* Change to admonition

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
---
 website/docs/deployment.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/website/docs/deployment.md b/website/docs/deployment.md
index b0433c02a6..9584f356be 100644
--- a/website/docs/deployment.md
+++ b/website/docs/deployment.md
@@ -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
 
 Specify the Git user as an environment variable.