docusaurus/packages/docusaurus-theme-classic
Bharat Middha 09550b0535
feat: properly type-check the Docusaurus config of new sites (#5589)
* fix: makes types DocusaurusConfig optional to match docs

* add UserDocusaurusConfig with required keys for user config

* convert UserDocusaurusConfig to use util type

* Docusaurus website config should be type-checked by CI + fix all existing issues

* add doc for config typechecking

* Update template configs for TS autocompletion

* fix last config typechecking bugs

* reapply prettier

* reapply prettier-docs

* Fix TS doc: add missing ()

* fix some docu plugin types

* add "const config" for simpler jsdoc annotation

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-30 17:49:44 +02:00
..
codeTranslations refactor: adjust styling of back top top button (#5469) 2021-09-11 16:09:58 +03:00
src feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
README.md refactor: rename Git master branch to main (#5345) 2021-08-17 18:41:53 +02:00
babel.config.js feat(v2): core v2 i18n support + Docusaurus site Crowdin integration (#3325) 2020-11-26 12:16:46 +01:00
package.json chore: upgrade dependencies (#5608) 2021-09-24 16:36:41 +02:00
tsconfig.json refactor(theme-classic): completely migrate package to TypeScript (#5459) 2021-09-01 14:34:26 +02:00
update-code-translations.js chore: upgrade Prettier + regenerate lock file (#5611) 2021-09-30 12:54:17 +02:00
update-code-translations.test.js feat: doc tags (same as blog tags) (#3646) 2021-08-19 10:31:15 +02:00

Docusaurus Theme Classic

The classic theme for Docusaurus.

Installation

Add docusaurus/theme-classic to your package:

npm i @docusaurus/theme-classic
# or
yarn add @docusaurus/theme-classic

Modify your docusaurus.config.js:

module.exports = {
  ...
+ themes: ['@docusaurus/theme-classic'],
  ...
}

Swizzling components

$ npm swizzle @docusaurus/theme-classic [component name]

All components used by this theme can be found here