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
..
bin	chore: upgrade Prettier + regenerate lock file (#5611 )	2021-09-30 12:54:17 +02:00
src	fix: install deps for new project via Yarn properly (#5490 )	2021-09-22 10:13:01 +02:00
templates	feat: properly type-check the Docusaurus config of new sites (#5589 )	2021-09-30 17:49:44 +02:00
README.md	feat(plugin-blog): multi-authors support + authors.yml global configuration (#5396 )	2021-08-26 12:21:58 +02:00
package.json	chore: upgrade dependencies (#5608 )	2021-09-24 16:36:41 +02:00
tsconfig.json	feat: new init template classic-typescript (#5233 )	2021-08-06 19:11:36 +02:00

README.md

`@docusaurus/init`

Create Docusaurus apps easily.

Usage

Please see the installation documentation.

For maintainers

For Docusaurus maintainers, templates can be tested with:

cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website
yarn docusaurus-init init test-website classic
cd test-website
yarn start

Note: test-website is not part of the workspace and use packages from npm.

Use the following to test the templates against local packages:

cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website-in-workspace
yarn docusaurus-init init test-website-in-workspace classic
cd test-website-in-workspace
yarn start