0.0.2 • Published 1 year ago

@sedoo/sedoo-doc-deploy v0.0.2

Weekly downloads
-
License
-
Repository
gitlab
Last release
1 year ago

Ce CLI permet d'uploader une documentation VuePress sur le CDN du SEDOO.

Utilisation

Dépendance

Le CLI s'ajoute dans les devDependencies du projet via la commande

npm i @sedoo/sedoo-doc-deploy --save-dev

Ajout du script

Dans la partie scripts du fichier package.json, il faut ajouter la ligne suivante

"scripts": {
        ...
        "docs:deploy": "node ./node_modules/@sedoo/sedoo-doc-deploy/index.js -p nomduprojet"
        ...
},

Exécution

L'execution s'effectue via la commande npm run docs:deploy

URL de la documentation

La documentation est alors disponible à l'url suivante: https://api.sedoo/aeris-cdn-rest/documentation/v1_0/nomduprojet_en_minuscule