CLI et scripts
Outils en ligne de commande et automatisation de build
Tout ce dont vous avez besoin pour créer, tester, linter et déployer la suite de documentation statique DocTunes en local et dans les pipelines CI/CD.
npm run devScript npm
Démarre le serveur de développement local sur le port 3000 avec rechargement à chaud.
bash
npm run devnpm run buildScript npm
Compile toutes les 20 pages en HTML statique et génère sitemap.xml.
bash
npm run buildnpm run lintScript npm
Exécute ESLint sur tous les composants TypeScript et React.
bash
npm run lintnpx serve outScript npm
Sert le répertoire de production statique 'out' localement pour révision.
bash
npx serve out -p 8080Flux de travail GitHub Actions pour le déploiement statique
Ajoutez ce flux de travail à .github/workflows/deploy.yml pour le déploiement statique automatisé sur GitHub Pages ou S3 à chaque push :
yaml
name: Déployer la documentation statique
on:
push:
branches: [main]
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci
- run: npm run build
- name: Déployer sur GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./out