Aller au contenu principal

CLI

DocStatic fournit un ensemble de scripts pour vous aider à générer, servir et déployer votre site web.

{
  // ...
  "scripts": {
    "docusaurus": "docusaurus",
    "dev": "tinacms dev -c \"docusaurus start\" ",
    "start": "docusaurus start",
    "generate-files": "node scripts/generate-file-list.js",
    "prebuild": "yarn generate-files",
    "predev": "yarn generate-files",
    "build": "tinacms build && docusaurus build",
    « build-local » : « tinacms build --local --skip-indexing --skip-cloud-checks && docusaurus build »,
    « swizzle » : « docusaurus swizzle »,
    « deploy » : « docusaurus deploy »,
    « clear » : « docusaurus clear »,
    « serve » : « docusaurus serve »,
    « write-translations » : « docusaurus write-translations »,
    « write-heading-ids » : « docusaurus write-heading-ids »,
    « gen-api-docs » : « docusaurus gen-api-docs »,
    « clean-api-docs » : « docusaurus clean-api-docs »,
    « gen-graphql » : « docusaurus docs:generate:graphql »,
    « gen-api-docs:version » : « docusaurus gen-api-docs:version »,
    « clean-api-docs:version » : « docusaurus clean-api-docs:version »,
    « lint » : « biome check apis/ config/ reuse/ scripts/ src/ static/ tina/ »,
    « lint:fix » : « biome check apis/ config/ reuse/ scripts/ src/ static/ tina/ --fix »
  }
}

Commandes CLI DocStatic​

Pour invoquer les commandes, utilisez yarn. Par exemple, yarn dev.

Ces commandes sont décrites dans CLI dans la documentation Docusaurus :

  • docusaurus
  • start
  • build
  • swizzle
  • deploy
  • clear
  • serve
  • write-translations
  • write-heading-ids

Commandes automatisées​

Ces commandes sont exécutées automatiquement au moment de la compilation ou au démarrage du serveur de développement :

  • generate-files
  • prebuild
  • predev

Commandes API​

  • clean-api-docs
  • gen-api-docs
  • gen-graphql

Pour plus d'informations sur les commandes OpenAPI, consultez la section Utilisation de la CLI dans la documentation du plugin OpenAPI de Docusaurus.

Pour plus d'informations sur la commande GraphQL, consultez la section Utilisation dans la documentation du plugin Docusaurus GraphQL.

Commandes de linting​

Pour plus d'informations sur les commandes de linting, consultez la section CLI de la documentation Biome.