3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-05 20:32:42 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/docusaurus-init/templates
History
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
..
bootstrap feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
classic feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
classic-typescript fix(module-type-aliases): move @type packages to dependencies (#5601) 2021-09-22 14:49:25 +02:00
facebook feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
shared feat(plugin-blog): multi-authors support + authors.yml global configuration (#5396) 2021-08-26 12:21:58 +02:00
README.md chore: regenerate beta.6 examples + fix regen script (#5484) 2021-09-03 16:54:06 +02:00

README.md

Templates

Official templates provided by Docusaurus. They are designed to be selected when using the npx @docusaurus/init init [name] [template] CLI command.

Guide to Test Templates for Developer

  1. yarn install in the root of the repo (one level above this directory).
  2. Go to any template's directory, example: cd classic && yarn start.