Skip to content

DOCS: Added information how to support GitHub Pages Custom Domain #2389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 20, 2021
Merged

DOCS: Added information how to support GitHub Pages Custom Domain #2389

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
398785d
Added note to handle GitHub Pages Custom Domain
flangel May 16, 2020
0ffd41d
Merge branch 'master' into patch-1
ulivz Dec 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/docs/docs/guide/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ cd -
You can also run the above script in your CI setup to enable automatic deployment on each push.
:::

::: tip
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.
:::


### GitHub Pages and GitHub Actions

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