Skip to main content

Configuration Docusaurus

Cet article décrit comment installer, tester, et deployer la documentation Docusaurus.

Prerequis​

  • Installer Node.js lts v20.18
  • Installer Yarn package manager for Node.js v1.22 : npm install -g yarn

Installation​

git clone https://github.com/Cat-aclsym/documentation
cd ./documentation
npm install

Test​

cd ./documentation
npm run start

Deploiement​

Deprecated

Le deploiement manuel n'est plus necessaire.

Pousser une modification sur la branche main provoque le deploiement automatiquement via une action github.

bash​

GIT_USER=<GITHUB_USERNAME> yarn deploy

windows​

cmd /C "set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy"

powershell​

cmd /C 'set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy'

Workflow​

  1. Mettre a jour la doc : git pull --rebase
  2. Modifier / Ajouter des pages
  3. Tester les modifications
  4. Pousser les mises a jour
git add .
git commit -m "..."
git push origin main

Liens utiles​