docs: github action directory name error and add prompt (#949)

Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
pull/951/head
Avan 2 years ago committed by GitHub
parent 1daeaa16a0
commit 0dafee79dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -65,7 +65,7 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f
### Using GitHub Actions ### 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 ```yaml
name: Deploy name: Deploy
@ -96,6 +96,10 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f
publish_dir: docs/.vitepress/dist publish_dir: docs/.vitepress/dist
``` ```
::: tip
Please replace the corresponding branch name. For example, if the branch you want to build is `master`, then you should replace `main` with `master` in the above file.
:::
2. Now commit your code and push it to the `main` branch. 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. 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.

Loading…
Cancel
Save