Skip to content

Commit

Permalink
Update cli.md
Browse files Browse the repository at this point in the history
  • Loading branch information
endiliey authored May 17, 2019
1 parent ae6b746 commit 32627af
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions website/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Compiles your site for production.

|Options|Default|Description|
|-|-|-|
|`--bundle-analyzer`||Starts [bundle analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)|
|`--bundle-analyzer`||Analyze your bundle with [bundle analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)|


### `docusaurus swizzle`
Expand All @@ -73,9 +73,8 @@ $ docusaurus swizzle <themeName> [componentName] [siteDir]

- `themeName`: name of the theme you are using
- `swizzleComponent`: name of the component to be swizzled
- `pathToNewComponent`: relative path to the desired location to the new component

Running the above command will copy the swizzle component to the path you indicated. You may then make any changes to the copied component and Docusaurus will use that component from then on.
Running the above command will copy the relevant theme files to your site folder. You may then make any changes to it and Docusaurus will use it instead of the one provided from the theme.

To unswizzle a component, simply delete the files of the swizzled component.

Expand All @@ -84,4 +83,4 @@ To learn more about swizzling, check [here](#).

### `docusaurus deploy`

Deploys your site with [GitHub Pages](https://pages.github.com/).
Deploys your site with [GitHub Pages](https://pages.github.com/).

0 comments on commit 32627af

Please sign in to comment.