Skip to content

Commit 6cdc528

Browse files
committed
update deployment guide
1 parent d6dc989 commit 6cdc528

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

README.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,11 @@ Once you have finished making changes, you can either commit them directly using
3737

3838
## 🖧 Deployment
3939

40-
To deploy your fork of the wiki to GitHub pages (for example to allow others to preview your changes):
41-
42-
1. Open `/wiki/.vitepress/config.ts`.
43-
2. Search for `export default defineConfig({`.
44-
3. Add an entry to this dictionary with `base: '<reponame>'` where `<reponame>` is the name of your forked repository.
45-
4. In the same file, search for `sitemap: {`.
46-
5. Change the `hostname` entry to `https://<username>.github.io/<reponame>/)` where `<username>` is your GitHub username and `<reponame>` is the name of your forked repository.
47-
6. [Enable GitHub pages from GitHub actions](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) on your repository.
48-
7. Whenever you push changes to the repository, GitHub will automatically attempt to deploy it. You can check the state in the Actions tab of your repository on GitHub.
49-
8. When you make a push request to the main repository, remember to exclude these changes!!
40+
To preview your changes, you'll need to [enable GitHub Pages from GitHub Actions](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) for your forked repository.
41+
42+
Once the workflow is complete, any changes made to the `master` branch will be deployed to the following URL automatically:
43+
44+
`https://{username}.github.io/{repository_name}/`
5045

5146
## 🔐 Licensing
5247

0 commit comments

Comments
 (0)