Skip to content

Commit

Permalink
Update custom template docs with instructions for testing custom temp…
Browse files Browse the repository at this point in the history
…late locally (#8092)

Co-authored-by: Ian Schmitz <ianschmitz@gmail.com>
  • Loading branch information
kevinold and ianschmitz committed Jan 30, 2020
1 parent 720d90b commit cafd602
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docusaurus/docs/custom-templates.md
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

0 comments on commit cafd602

Please sign in to comment.