3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-04 03:42:34 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2): display yarn and npm command on website (#2037)

Browse source 
* docs(v2): display yarn and npm command on website

* more

* fix div cannot be descendant p
This commit is contained in:
Endi 2019-11-24 09:32:26 +07:00 • committed by Yangshun Tay
parent 3265dda895
commit c533adc4aa
12 changed files with 104 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

8
website/docs/using-themes.md
View file

@ -75,18 +75,20 @@ The content plugin remains the same and the only thing you need to change is the
## Swizzling theme components
> ⚠️ We would like to discourage swizzling of components until we've minimally reached a Beta stage. The components APIs have been changing rapidly and are likely to keep changing until we reach Beta. Stick with the default appearance for now if possible to save yourself some potential pain in future.
Docusaurus Themes' components are designed to be replaceable. To make it easier for you, we created a command for you to replace theme components called `swizzle`.
To swizzle a component for a theme, run the following command in your doc site:
```shell
$ docusaurus swizzle [theme name] [component name]
docusaurus swizzle <theme name> [component name]
```
As an example, to swizzle the `<Footer />` component in `@docusaurus/theme-classic` for your site, run:
```shell
$ npm swizzle @docusaurus/theme-classic Footer
```bash npm2yarn
npm run swizzle @docusaurus/theme-classic Footer
```
This will copy the current `<Footer />` component used by the theme to a `src/theme/Footer` directory under the root of your site, which is where Docusaurus will look for swizzled components. Docusaurus will then use swizzled component in place of the original one from the theme.