docs(v2) themes - #1645
Conversation
|
Deploy preview for docusaurus-2 ready! Built with commit 92504a0 |
|
Deploy preview for docusaurus-preview ready! Built with commit 92504a0 |
|
exemplify swizzling heading #1687 |
f352ecb to
a234f33
Compare
|
Hey @endiliey @yangshun these docs are ready for a round of review. Please let me know what you think and places to improve. There are quite some changes around how plugins and themes docs are organized. Please make sure you browse around these sections on the preview sites to get a feeling that they make sense:
I've also combined the API docs for themes and plugins to a file called Lifecycle APIs because themes and plugins share the same lifecycle methods. |
endiliey
left a comment
There was a problem hiding this comment.
some suggestions and typo
will rereview again
| '@docusaurus/plugin-content-pages', | ||
| [ | ||
| // Plugin with options | ||
| '@docusaurus/plugin-content-blog', |
There was a problem hiding this comment.
since passing options is mentioned in the next section, lets simplify this part
| A plugin is an npm package, so you install them like other npm packages using npm. | ||
|
|
||
| ```bash | ||
| yarn add docusaurus-plugin-name |
| As an example, to swizzle the `<Footer />` component in `@docusaurus/theme-classic` for your site, run: | ||
|
|
||
| ```shell | ||
| $ yarn swizzle @docusaurus/theme-classic |
There was a problem hiding this comment.
typo here.
npm swizzle @docusaurus/theme-classic Footer
| - [@docusaurus/plugin-content-pages](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-content-pages) | ||
| - [@docusaurus/plugin-google-analytics](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-google-analytics) | ||
| - [@docusaurus/plugin-google-gtag](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-google-gtag) | ||
| - [@docusaurus/plugin-sitemap](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-sitemap) |
There was a problem hiding this comment.
mention plugin ideal image too
| Themes provide the consistent components for your doc sites. | ||
|
|
||
| <!-- TODO: WIP intro --> | ||
|
|
There was a problem hiding this comment.
i find it hard to understand themes without reading advanced guide-themes. I think we should try giving user understanding of themes first before teaching them how to use it. Not really sure whats the best approach
|
@endiliey updated |
…link to directory
|
@endiliey removed it and replaced with the theme folder |
|
we can always tweak. merged |
* More prep * rename xxx-api to api-xxx * move content around for plugins and themes * wip docs: using themes * docs(v2): tweak using plugins * docs(v2): list official themes in docs * docs(v2): advanced themes * wip notes for lifecycle apis * resolve PR review discussions * lower case "theme" * better intro for using themes * add a simple README to @docusaurus/theme-classic * remove list of components from theme classic README and replace with link to directory
Motivation
Add docs for themes
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
NA
Related PRs
#1640