Skip to content

Commit eb2d1d0

Browse files
committed
Update readme with github pages url
1 parent a52fd9b commit eb2d1d0

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ The goal of this repository is to provide one consistent documentation home acro
77
## Live site
88

99
- [docs.nxtgrid.co](http://docs.nxtgrid.co/)
10+
- [nxtgrid.github.io/nxt-docs](https://nxtgrid.github.io/nxt-docs/)
11+
12+
## Deployment targets
13+
14+
- Netlify remains the primary deployment target for `https://docs.nxtgrid.co`.
15+
- GitHub Pages is configured as a secondary deployment target at `https://nxtgrid.github.io/nxt-docs/`.
16+
- GitHub Pages deploys are handled by `.github/workflows/deploy-pages.yml`.
17+
- The Docusaurus config uses `DOCS_DEPLOY_TARGET` to switch site URL/base path:
18+
- `netlify` -> `url=https://docs.nxtgrid.co`, `baseUrl=/`
19+
- `gh-pages` -> `url=https://nxtgrid.github.io`, `baseUrl=/nxt-docs/`
1020

1121
## Project scope
1222

@@ -31,12 +41,24 @@ npm start
3141

3242
The development server runs with hot reload for docs and config changes.
3343

44+
To simulate GitHub Pages locally:
45+
46+
```bash
47+
DOCS_DEPLOY_TARGET=gh-pages npm start
48+
```
49+
3450
## Production build
3551

3652
```bash
3753
npm run build
3854
```
3955

56+
To produce a GitHub Pages-compatible build locally:
57+
58+
```bash
59+
DOCS_DEPLOY_TARGET=gh-pages npm run build
60+
```
61+
4062
## How to add or update repository docs
4163

4264
1. Copy the template from `docs/templates/repository-template.mdx`.

0 commit comments

Comments
 (0)