Skip to content

Commit

Permalink
docs(v2): fix npm/yarn command example for swizzling TypeScript theme…
Browse files Browse the repository at this point in the history
… components (#4230)
  • Loading branch information
YashTotale authored Feb 17, 2021
1 parent bb63e09 commit cf080c7
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Now you can start writing TypeScript theme components.
For themes that supports TypeScript theme components, you can add the `--typescript` flag to the end of swizzling command to get TypeScript source code. For example, the following command will generate `index.tsx` and `styles.module.css` into `src/theme/Footer`.

```bash npm2yarn
npm run swizzle @docusaurus/theme-classic Footer --typescript
npm run swizzle @docusaurus/theme-classic Footer -- --typescript
```

At this moment, the only official Docusaurus theme that supports TypeScript theme components is `@docusaurus/theme-classic`. If you are a Docusaurus theme package author who wants to add TypeScript support, see the [Lifecycle APIs docs](./lifecycle-apis.md#gettypescriptthemepath).

0 comments on commit cf080c7

Please sign in to comment.