Aller au contenu principal
Version: 2.4.3

📦 create-docusaurus

Un utilitaire d'échafaudage pour vous aider à mettre en place instantanément une application Docusaurus fonctionnelle.

Utilisation​

npx create-docusaurus@latest [name] [template] [rootDir]

The 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 rootDir.

The template argument can be one of the following:

  • classic: Uses the classic template (recommended)
  • facebook: Uses the Facebook/Meta template, which contains some Meta-specific setup
  • A git repo URL (beginning with https:// or git@), which can be cloned to the destination
  • Un chemin de fichier local relatif à CWD, qui contient les fichiers à copier vers la destination

The rootDir will be used to resolve the absolute path to the site directory. La valeur par défaut est CWD.

attention

Cette commande devrait être utilisée de préférence dans un shell interactif afin que toutes les fonctionnalités soient disponibles.

Options​

-t, --typescript​

Utilisé lorsque l'argument template est un nom reconnu. Currently, only classic provides a TypeScript variant.

-g, --git-strategy​

Utilisé lorsque l'argument template est un dépôt git. Cela doit être l'un des suivants :

  • deep: preserves full git history
  • shallow: clones with --depth=1
  • copy: does a shallow clone, but does not create a git repo
  • custom: enter your custom git clone command. On vous le demandera. You can write something like git clone --depth 10, and we will append the repository URL and destination directory.

-p, --package-manager​

Value should be one of npm, yarn, or pnpm. Si ce n'est pas explicitement fourni, Docusaurus en déduira un basé sur :

  • Le fichier de verrouillage déjà présent dans le CWD (par exemple, si vous configurez un site Web dans un projet existant)
  • The command used to invoke create-docusaurus (e.g. npm init, npx, yarn create, etc.)
  • Demande interactive, au cas où toutes les techniques de résolution ne seraient pas présentes

-s, --skip-install​

Si fourni, Docusaurus n'installera pas automatiquement les dépendances après la création de l'application. The --package-manager option is only useful when you are actually installing dependencies.