Skip to content

Commit

Permalink
docs: update template/website documentation (jaredpalmer#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
aboveyunhai authored Oct 10, 2021
1 parent 544bbce commit 33f60c0
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions templates/react-with-storybook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Congrats! You just saved yourself hours of work by bootstrapping this project wi
## Commands

DTS scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
DTS scaffolds your new library inside `/src`, and also sets up a [Vite-based](https://vitejs.dev) playground for it inside `/example`.

The recommended workflow is to run DTS in one terminal:

Expand Down Expand Up @@ -42,7 +42,7 @@ npm i # or yarn to install dependencies
npm start # or yarn start
```

The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure DTS is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure DTS is running in watch mode like we recommend above.

To do a one-off build, use `npm run build` or `yarn build`.

Expand Down Expand Up @@ -130,7 +130,7 @@ The appropriate paths are configured in `package.json` and `dist/index.js` accor

## Deploying the Example Playground

The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
The Playground is just a simple [Vite](https://vitejs.dev) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):

```bash
cd example # if not already in the example folder
Expand Down
6 changes: 3 additions & 3 deletions templates/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Congrats! You just saved yourself hours of work by bootstrapping this project wi
## Commands

DTS scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
DTS scaffolds your new library inside `/src`, and also sets up a [Vite-based](https://vitejs.dev) playground for it inside `/example`.

The recommended workflow is to run DTS in one terminal:

Expand All @@ -26,7 +26,7 @@ npm i # or yarn to install dependencies
npm start # or yarn start
```

The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure DTS is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure DTS is running in watch mode like we recommend above.

To do a one-off build, use `npm run build` or `yarn build`.

Expand Down Expand Up @@ -109,7 +109,7 @@ The appropriate paths are configured in `package.json` and `dist/index.js` accor

## Deploying the Example Playground

The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
The Playground is just a simple [Vite](https://vitejs.dev) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):

```bash
cd example # if not already in the example folder
Expand Down
2 changes: 1 addition & 1 deletion website/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You'll be prompted to choose from one of three project templates:
| Template | Description |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `basic` | A plain TypeScript project setup you can use for any kind of module. |
| `react` | A React package with necessary development dependencies and `@types` installed. In addition, there is a [Parcel](https://parceljs.org/)-powered React playground you can use while you develop. |
| `react` | A React package with necessary development dependencies and `@types` installed. In addition, there is a [Vite](https://vitejs.dev)-powered React playground you can use while you develop. |
| `react-with-storybook` | Same as the basic React template, but with [React Storybook](https://storybook.js.org/) already setup as well. |

After you select one, TSDX will create a folder with the project template in it and install all dependencies. Once that's done, you're ready-to-rock! TypeScript, Rollup, Jest, ESlint and all other plumbing is already setup with best practices. Just start editing `src/index.ts` (or `src/index.tsx` if you chose one of the React templates) and go!
Expand Down

0 comments on commit 33f60c0

Please sign in to comment.