A scaffolding utility to help you instantly set up a functional Docusaurus app.
npx [email protected] [name] [template] [rootDir]
name argument will be used as the site's path as well as the
name field in the created app's package.json. It can be an absolute path, or a path relative to
template argument can be one of the following:
classic: Uses the classic template (recommended)
- A git repo URL (beginning with
git@), which can be cloned to the destination
- A local file path relative to CWD, which contains the files to be copied to destination
rootDir will be used to resolve the absolute path to the site directory. The default is CWD.
This command should be preferably used in an interactive shell so all features are available.
Used when the template argument is a recognized name. Currently, only
classic provides a TypeScript variant.
Used when the template argument is a git repo. It needs to be one of:
deep: preserves full git history
shallow: clones with
copy: does a shallow clone, but does not create a git repo
custom: enter your custom git clone command. We will prompt you for it. You can write something like
git clone --depth 10, and we will append the repository URL and destination directory.
Value should be one of
pnpm. If it's not explicitly provided, Docusaurus will infer one based on:
- The lockfile already present in the CWD (e.g. if you are setting up website in an existing project)
- The command used to invoke
yarn create, etc.)
- Interactive prompting, in case all heuristics are not present
If provided, Docusaurus will not automatically install dependencies after creating the app. The
--package-manager option is only useful when you are actually installing dependencies.