docusaurus/website
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
..
_dogfooding feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
blog feat(plugin-blog): multi-authors support + authors.yml global configuration (#5396) 2021-08-26 12:21:58 +02:00
community docs: add additional search options, typesense and local search (#5489) 2021-09-22 17:41:27 +02:00
docs feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
src feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
static fix: fix site unlocalized 404 pages + aggressive Netlify /assets caching (#5399) 2021-08-20 19:37:20 +02:00
versioned_docs chore: upgrade Prettier + regenerate lock file (#5611) 2021-09-30 12:54:17 +02:00
versioned_sidebars chore: remove beta.4 docs (already archived) (#5474) 2021-09-02 18:56:22 +02:00
README.md
babel.config.js
delayCrowdin.js
docusaurus.config-blog-only.js refactor: rename Git master branch to main (#5345) 2021-08-17 18:41:53 +02:00
docusaurus.config.js feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
netlify.toml
package.json feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
sidebars.js
sidebarsCommunity.js refactor: clean Canny integration + rename 'Feedback' to 'Feature Requests' + improve TS doc page (#5389) 2021-08-20 11:42:13 +02:00
tsconfig.json fix: fix a few TS errors (#5437) 2021-08-30 13:06:00 +02:00
versions.json chore: remove beta.4 docs (already archived) (#5474) 2021-09-02 18:56:22 +02:00
versionsArchived.json chore(v2): prepare v2.0.0-beta.6 release (#5473) 2021-09-02 18:31:42 +02:00
waitForCrowdin.js refactor: rename Git master branch to main (#5345) 2021-08-17 18:41:53 +02:00

README.md

Docusaurus 2 Website

Installation

  1. yarn install in the root of the repo (one level above this directory).
  2. In this directory, do yarn start.
  3. A browser window will open up, pointing to the docs.