diff --git a/docs/guide/deploying.md b/docs/guide/deploying.md index 5765bef5..53404362 100644 --- a/docs/guide/deploying.md +++ b/docs/guide/deploying.md @@ -65,7 +65,7 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f ### Using GitHub Actions -1. Create a file named `deploy.yml` inside `.github/workflow` directory of your project with the following content: +1. Create a file named `deploy.yml` inside `.github/workflows` directory of your project with the following content: ```yaml name: Deploy @@ -96,6 +96,12 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f publish_dir: docs/.vitepress/dist ``` +::: tip + +Please replace the corresponding branch name. For example, the branch you want to trigger is `master` branch, then you should replace `main` with `master`. + +::: + 2. Now commit your code and push it to the `main` branch. 3. Wait for actions to complete. Then select `gh-pages` branch as GitHub Pages source in your repository settings. Now your docs will automatically deploy each time you push.