mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-17 00:35:50 +02:00
f4f458460c
* 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
31 lines
584 B
Markdown
31 lines
584 B
Markdown
# Docusaurus Theme Classic
|
|
|
|
The classic theme for Docusaurus.
|
|
|
|
## Installation
|
|
|
|
Add `docusaurus/theme-classic` to your package:
|
|
|
|
```bash
|
|
npm i @docusaurus/theme-classic
|
|
# or
|
|
yarn add @docusaurus/theme-classic
|
|
```
|
|
|
|
Modify your `docusaurus.config.js`:
|
|
|
|
```diff
|
|
module.exports = {
|
|
...
|
|
+ themes: ['@docusaurus/theme-classic'],
|
|
...
|
|
}
|
|
```
|
|
|
|
## Swizzling components
|
|
|
|
```shell
|
|
$ npm swizzle @docusaurus/theme-classic [component name]
|
|
```
|
|
|
|
All components used by this theme can be found [here](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-theme-classic/src/theme)
|