Skip to content

Update custom template docs with instructions for testing custom template locally #8092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 30, 2020
Merged

Update custom template docs with instructions for testing custom template locally #8092

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3402bd6
Update custom template docs with instructions for testing custom temp…
kevinold Dec 5, 2019
4235790
Update custom-templates.md
ianschmitz Jan 30, 2020
d27ff4b
Merge branch 'master' into testing-custom-templates
ianschmitz Jan 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docusaurus/docs/custom-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,8 @@ You'll notice that Custom Templates are always named in the format `cra-template

Scoped templates are also supported, under the name `@[scope-name]/cra-template` or `@[scope-name]/cra-template-[template-name]`, which can be installed via `@[scope]` and `@[scope]/[template-name]` respectively.

### npm

```sh
npm init react-app my-app --template [template-name]
```

### Yarn

```sh
yarn create react-app my-app --template [template-name]
npx create-react-app my-app --template [template-name]
```

## Finding custom templates
Expand Down Expand Up @@ -52,6 +44,14 @@ my-app/
index.js (or index.tsx)
```

### Testing a template

To test a template locally, pass the file path to the directory of your template source using the `file:` prefix.

```sh
npx create-react-app my-app --template file:../path/to/your/template/cra-template-[template-name]
```

### The `template` folder

This folder is copied to the user's app directory as Create React App installs. During this process, the file `gitignore` is renamed to `.gitignore`.
Expand Down