Skip to content

Commit 22bae47

Browse files
flangelulivz
andauthored
docs: add note to handle github pages custom domain (#2389)
Co-authored-by: ULIVZ <chenhaoli@bytedance.com>
1 parent e4184a2 commit 22bae47

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

packages/docs/docs/guide/deploy.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,11 @@ cd -
5656
You can also run the above script in your CI setup to enable automatic deployment on each push.
5757
:::
5858

59+
::: tip
60+
When you use a **Custom Domain name**, you MUST add the CNAME file into /docs/.vuepress/public folder (Create the folder if it isn't there). Otherwise, your CNAME file will always be removed with each deploy and never work.
61+
:::
62+
63+
5964
### GitHub Pages and GitHub Actions
6065

6166
1. [Create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token);

0 commit comments

Comments
 (0)