Skip to content

Commit

Permalink
chore(docs): Replace ref to master by ref to main (#1694)
Browse files Browse the repository at this point in the history
Co-authored-by: Renato Benkendorf <[email protected]>
  • Loading branch information
npalm and renatobenks authored Feb 7, 2022
1 parent bfcd923 commit b275615
Show file tree
Hide file tree
Showing 36 changed files with 49 additions and 49 deletions.
4 changes: 2 additions & 2 deletions examples/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-basic
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/basic
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/basic
mv basic docz-basic-example
cd docz-basic-example
```
Expand All @@ -38,4 +38,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
2 changes: 1 addition & 1 deletion examples/create-react-app-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-cra --example create-react-app-ts
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/cra
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/cra
mv cra docz-cra-example
cd docz-cra-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/create-react-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-cra --example create-react-app
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/create-react-app
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/create-react-app
mv create-react-app docz-cra-example
cd docz-cra-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-base-path/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-custom-base-path -- example custom-base-path
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/custom-base-path
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/custom-base-path
mv basic docz-custom-base-path-example
cd docz-custom-base-path-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-config-location/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app --example custom-config-location
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/custom-config-location
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/custom-config-location
mv custom-config-location docz-custom-config-location-example
cd docz-custom-config-location-example
```
Expand Down
4 changes: 2 additions & 2 deletions examples/flow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-flow --example flow
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/flow
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/flow
mv flow docz-flow-example
cd docz-flow-example
```
Expand All @@ -38,4 +38,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
4 changes: 2 additions & 2 deletions examples/gatsby/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ yarn create docz-app docz-app-gatsby --example gatsby
## Download

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/gatsby
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/gatsby
mv gatsby docz-gatsby-example
cd docz-gatsby-example
```
Expand All @@ -41,4 +41,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
4 changes: 2 additions & 2 deletions examples/images/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-images --example images
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/images
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/images
mv images docz-images-example
cd docz-images-example
```
Expand All @@ -38,4 +38,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
2 changes: 1 addition & 1 deletion examples/less/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-less --example less
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/less
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/less
mv less docz-less-example
cd docz-less-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/logo-in-sidebar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-logo-in-sidebar --example logo-in-sidebar
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/logo-in-sidebar
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/logo-in-sidebar
mv logo-in-sidebar docz-logo-in-sidebar-example
cd docz-logo-in-sidebar-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-basic --example material-ui
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/material-ui
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/material-ui
mv material-ui docz-material-ui-example
cd docz-material-ui-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/monorepo-package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ yarn create docz-app docz-app-monorepo --example monorepo-package
## Download

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/monorepo-package
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/monorepo-package
mv monorepo-package docz-monorepo-example
cd docz-monorepo-example
```
Expand Down
4 changes: 2 additions & 2 deletions examples/monorepo-package/packages/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-basic
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/basic
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/basic
mv basic docz-basic-example
cd docz-basic-example
```
Expand All @@ -38,4 +38,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
2 changes: 1 addition & 1 deletion examples/monorepo-separate-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ yarn create docz-app docz-app-monorepo-separate-docs --example monorepo-separate
## Download

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/monorepo-separate-docs
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/monorepo-separate-docs
mv monorepo-separate-docs docz-monorepo-separate-docs-example
cd docz-monorepo-separate-docs-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/monorepo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ yarn create docz-app docz-app-monorepo --example monorepo
## Download

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/monorepo
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/monorepo
mv monorepo docz-monorepo-example
cd docz-monorepo-example
```
Expand Down
4 changes: 2 additions & 2 deletions examples/monorepo/packages/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-basic
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/basic
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/basic
mv basic docz-basic-example
cd docz-basic-example
```
Expand All @@ -38,4 +38,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
4 changes: 2 additions & 2 deletions examples/now/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-now --example now
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/now
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/now
mv now docz-example-now
docz-example-now
```
Expand Down Expand Up @@ -46,4 +46,4 @@ yarn serve # npm run serve
yarn deploy
```

Note that by default `docz` generates the output site in `.docz/public` to change that add a `dest` field to your `doczrc.js` with the path you want to generate the code in.
Note that by default `docz` generates the output site in `.docz/public` to change that add a `dest` field to your `doczrc.js` with the path you want to generate the code in.
4 changes: 2 additions & 2 deletions examples/react-router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-react-router --example react-router
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/react-router
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/react-router
mv react-router docz-react-router-example
cd docz-react-router-example
```
Expand Down Expand Up @@ -43,4 +43,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
2 changes: 1 addition & 1 deletion examples/sass/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-sass --example sass
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/sass
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/sass
mv sass docz-sass-example
cd docz-sass-example
```
Expand Down
4 changes: 2 additions & 2 deletions examples/shadowed-playground/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-shadowed-playground
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/shadowed-playground
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/shadowed-playground
mv shadowed-playground docz-shadowed-playground-example
cd docz-shadowed-playground-example
```
Expand All @@ -38,4 +38,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
2 changes: 1 addition & 1 deletion examples/styled-components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-styled-docz --example styled-components
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/styled-components
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/styled-components
mv styled-components docz-example-styled-docz
```

Expand Down
2 changes: 1 addition & 1 deletion examples/stylus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-stylus --example stylus
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/stylus
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/stylus
mv stylus docz-stylus-example
cd docz-stylus-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-typescript --example typescript
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/typescript
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/typescript
mv typescript docz-typescript-example
cd docz-typescript-example
```
Expand Down
4 changes: 2 additions & 2 deletions examples/webpack-alias/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-webpack-alias --example webpack-alias
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/webpack-alias
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/webpack-alias
mv webpack-alias docz-webpack-alias-example
cd docz-webpack-alias-example
```
Expand Down Expand Up @@ -64,4 +64,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
2 changes: 1 addition & 1 deletion examples/with-algolia-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ yarn create docz-app docz-app-with-algolia-search --example with-algolia-search
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-algolia-search
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-algolia-search
mv with-algolia-search docz-with-algolia-search-example
cd docz-with-algolia-search-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/with-custom-404-page/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ yarn create docz-app docz-app-basic --example with-custom-404-page
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-custom-404-page
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-custom-404-page
mv with-custom-404-page docz-with-custom-404-page-example
cd docz-with-custom-404-page-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/with-custom-docz-theme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ yarn create docz-app docz-app-with-custom-docz-theme
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-custom-docz-theme
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-custom-docz-theme
mv with-custom-docz-theme docz-with-custom-docz-theme-example
cd docz-with-custom-docz-theme-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/with-custom-links/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-with-custom-links --example with-custom-links
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-custom-links
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-custom-links
mv with-custom-links docz-with-custom-links-example
cd docz-with-custom-links-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/with-decorators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-with-decorators --example with-decorators
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-decorators
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-decorators
mv with-decorators docz-with-decorators-example
cd docz-with-decorators-example
```
Expand Down
6 changes: 3 additions & 3 deletions examples/with-env-variables/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ yarn create docz-app docz-app-with-env-variables
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-env-variables
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-env-variables
mv with-env-variables docz-with-env-variables-example
cd docz-with-env-variables-example
```

## Notes

Environment variables are defined in `gatsby-node.js` by changing the webpack config (process.env.FOO, process.env.PROD) or in .env.* and then imported using `dotenv` in `gatsby-config.js` (process.env.GATSBY_API_URL).
Environment variables are defined in `gatsby-node.js` by changing the webpack config (process.env.FOO, process.env.PROD) or in .env.* and then imported using `dotenv` in `gatsby-config.js` (process.env.GATSBY_API_URL).

## Setup

Expand All @@ -42,4 +42,4 @@ yarn build # npm run build

```sh
yarn serve # npm run serve
```
```
2 changes: 1 addition & 1 deletion examples/with-favicon-and-metadata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-with-favicon-and-metadata --example with-favicon-a
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-favicon-and-metadata
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-favicon-and-metadata
mv with-favicon-and-metadata docz-with-favicon-and-metadata-example
cd docz-with-favicon-and-metadata-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/with-gatsby-remark-vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ yarn create docz-app docz-app-with-gatsby-remark-vscode
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-gatsby-remark-vscode
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-gatsby-remark-vscode
mv with-gatsby-remark-vscode docz-with-gatsby-remark-vscode-example
cd docz-with-gatsby-remark-vscode-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/with-styled-components-and-scoping/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-styled-docz --example with-styled-components-and-s
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-styled-components-and-scoping
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-styled-components-and-scoping
mv with-styled-components-and-scoping docz-example-styled-docz
```

Expand Down
2 changes: 1 addition & 1 deletion examples/with-themes-dir/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-with-themes-dir
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-themes-dir
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-themes-dir
mv with-themes-dir docz-with-themes-dir-example
cd docz-with-themes-dir-example
```
Expand Down
2 changes: 1 addition & 1 deletion examples/with-typescript-decorators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yarn create docz-app docz-app-with-typescript-decorators --example with-typescri
## Download manually

```sh
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/with-typescript-decorators
curl https://codeload.github.com/doczjs/docz/tar.gz/main | tar -xz --strip=2 docz-main/examples/with-typescript-decorators
mv with-typescript-decorators docz-with-typescript-decorators-example
cd docz-with-typescript-decorators-example
```
Expand Down
Loading

0 comments on commit b275615

Please sign in to comment.