Skip to content
This repository was archived by the owner on Nov 21, 2025. It is now read-only.

Commit 41039a6

Browse files
authored
docs: add notes to custom-base-path example
1 parent 485b843 commit 41039a6

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

examples/custom-base-path/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
1-
# Basic Docz example
1+
# Custom base path docz example
22

33
## Using `create-docz-app`
44

55
```sh
6-
npx create-docz-app docz-app-basic
6+
npx create-docz-app docz-app-custom-base-path --example custom-base-path
77
# or
8-
yarn create docz-app docz-app-basic
8+
yarn create docz-app docz-app-custom-base-path -- example custom-base-path
99
```
1010

1111
## Download manually
1212

1313
```sh
14-
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/basic
15-
mv basic docz-basic-example
16-
cd docz-basic-example
14+
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/custom-base-path
15+
mv basic docz-custom-base-path-example
16+
cd docz-custom-base-path-example
1717
```
1818

19+
## Notes
20+
21+
`base` is added to doczrc and mapped to gatsby's `prefixPaths`
22+
1923
## Setup
2024

2125
```sh
@@ -38,4 +42,4 @@ yarn build # npm run build
3842

3943
```sh
4044
yarn serve # npm run serve
41-
```
45+
```

0 commit comments

Comments
 (0)