Shiloh/old-remnantchat
Shiloh/old-remnantchat
1
0
Fork 1
Code Issues Pull Requests Packages Projects 4 Releases Wiki Activity

docs(readme): update GitHub Pages hosting documentation

Browse Source
This commit is contained in:
Jeremy Kahn 2024-04-06 17:43:38 -05:00
parent df6d10868e
commit 3a4a09ce69
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -195,16 +195,16 @@ Assuming you are hosting Chitchatter on [GitHub Pages](https://pages.github.com/
1. Change the [`homepage` property in `package.json`](https://github.com/jeremyckahn/chitchatter/blob/1ea67e2c3a45115e054ebfe3457f2c3572c6213b/package.json#L4) to whatever URL your Chitchatter instance will be hosted from. This will be something like `https://github_user_or_org_name.github.io/chitchatter/`.
2. Define a [`DEPLOY_KEY` GitHub Action secret](https://github.com/jeremyckahn/chitchatter/blob/e2bac732cf1288f7b5d0bec151098f18e8b1d0d6/.github/workflows/deploy.yml#L28-L31) (at `https://github.com/github_user_or_org_name/chitchatter/settings/secrets/actions`). See the docs for [`peaceiris/actions-gh-pages`](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-set-ssh-private-key-deploy_key) for more information.
3. If you're using gh-pages without custom domain then define `base` property as repo name under `vite.config.ts` like
3. If you're using GitHub Pages [without a custom domain](https://github.com/sitek94/vite-deploy-demo?tab=readme-ov-file#fix-assets-links), you'll need to define the repo name as the `base` property [in `vite.config.ts`](https://github.com/jeremyckahn/chitchatter/blob/df6d10868e12ad13036a44f959796f4da35adc28/vite.config.ts#L35-L38). Here's an example of how that might look:
```js
const config = () => {
return defineConfig({
base: '/chitchatter/',
build: {
...
}
```
```js
const config = () => {
return defineConfig({
base: '/chitchatter/',
build: {
...
}
```
#### Deployment