Aller au contenu principal
Version : Canary 🚧

📩 create-docusaurus

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

Utilisation​

npx create-docusaur[email protected] [name] [template] [rootDir]

L'argument name sera utilisĂ© comme chemin d'accĂšs du site ainsi que le champ name dans le package.json de l'application crĂ©Ă©e. Il peut ĂȘtre un chemin absolu, ou un chemin relatif Ă  rootDir.

L'argument template peut ĂȘtre l'un des suivants :

  • classic : Utilise le template classic (recommandĂ©)
  • facebook : Utilise le template Facebook/Meta, qui contient des configurations spĂ©cifiques Ă  MĂ©ta
  • Une URL de dĂ©pĂŽt git (commençant par https:// ou [email protected]), qui peut ĂȘtre clonĂ©e vers la destination
  • Un chemin de fichier local relatif Ă  CWD, qui contient les fichiers Ă  copier vers la destination

Le rootDir sera utilisé pour résoudre le chemin absolu vers le répertoire du site. 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. Actuellement, seul classic fournit une variante TypeScript.

-g, --git-strategy​

UtilisĂ© lorsque l'argument template est un dĂ©pĂŽt git. Cela doit ĂȘtre l'un des suivants :

  • deep : conserve complĂ©tement l'historique git
  • shallow : clone avec --depth=1
  • copy : fait un clone shallow, mais ne crĂ©e pas un dĂ©pĂŽt git
  • custom : saisissez votre commande de clone git personnalisĂ©e. On vous le demandera. Vous pouvez Ă©crire quelque chose comme git clone --depth 10, et nous ajouterons l'URL du dĂ©pĂŽt et le rĂ©pertoire de destination.

-p, --package-manager​

La valeur doit ĂȘtre une des valeurs suivantes npm, yarn, ou 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)
  • La commande utilisĂ©e pour appeler create-docusaurus (par exemple 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. L'option --package-manager n'est utile que lorsque vous installez des dépendances.