History

Sébastien Lorber fd43036ab8 Some checks failed Argos CI / take-screenshots (push) Has been cancelled Details Build Hash Router / Build Hash Router (push) Has been cancelled Details Canary Release / Publish Canary (push) Has been cancelled Details CodeQL / Analyze (javascript) (push) Has been cancelled Details Continuous Releases / Continuous Releases (push) Has been cancelled Details E2E Tests / E2E — Yarn v1 (18.0) (push) Has been cancelled Details E2E Tests / E2E — Yarn v1 (20) (push) Has been cancelled Details E2E Tests / E2E — Yarn v1 (22) (push) Has been cancelled Details E2E Tests / E2E — Yarn Berry (node-modules, -s) (push) Has been cancelled Details E2E Tests / E2E — Yarn Berry (node-modules, -st) (push) Has been cancelled Details E2E Tests / E2E — Yarn Berry (pnp, -s) (push) Has been cancelled Details E2E Tests / E2E — Yarn Berry (pnp, -st) (push) Has been cancelled Details E2E Tests / E2E — npm (push) Has been cancelled Details E2E Tests / E2E — pnpm (push) Has been cancelled Details chore: release Docusaurus 3.6.3 (#10713 )		2024-11-22 17:13:56 +01:00
..
bin	refactor: move PerfLogger from core to @docusaurus/logger (#10480 )	2024-09-06 10:58:53 +02:00
src	refactor: move PerfLogger from core to @docusaurus/logger (#10480 )	2024-09-06 10:58:53 +02:00
templates	chore: release Docusaurus 3.6.3 (#10713 )	2024-11-22 17:13:56 +01:00
.npmignore	misc: make copyUntypedFiles work for watch mode (#7445 )	2022-05-18 19:18:32 +08:00
README.md	feat(create-docusaurus): ask user for preferred language when no language CLI option provided (#9442 )	2024-02-15 13:05:05 +01:00
package.json	chore: release Docusaurus 3.6.3 (#10713 )	2024-11-22 17:13:56 +01:00
tsconfig.build.json	chore: simplify TypeScript configs, use TS 5.5 configDir placeholder (#10256 )	2024-07-01 17:34:40 +02:00
tsconfig.json	chore: simplify TypeScript configs, use TS 5.5 configDir placeholder (#10256 )	2024-07-01 17:34:40 +02:00

README.md

`create-docusaurus`

Create Docusaurus apps easily with simplified commands:

npm init docusaurus

yarn create docusaurus

npx create-docusaurus@latest

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 create-docusaurus test-website classic --javascript
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 create-docusaurus test-website-in-workspace classic --javascript
cd test-website-in-workspace
yarn build
yarn start

For the TypeScript template:

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