VuePress documentation

.github/workflows/vuepress-deploy.yml

@@ -0,0 +1,20 @@
+name: Build and Deploy
+on: [push]
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+
+    - name: copy openAPI spec for swagger
+      run: cp ./standard-covoiturage_openapi.yaml ./docs/src/.vuepress/public/standard-covoiturage_openapi.yaml
+
+    - name: vuepress-deploy
+      uses: jenkey2011/vuepress-deploy@master
+      env:
+        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        TARGET_REPO: fabmob/standard-covoiturage
+        TARGET_BRANCH: gh-pages
+        BUILD_SCRIPT: npm install --prefix docs && npm run build --prefix docs
+        BUILD_DIR: docs/src/.vuepress/dist

README.fr.md

@@ -11,10 +11,12 @@ généralement permettre des échanges de services entre opérateurs de covoitur
 et opérateurs de MaaS.
 
 
+Veuillez consulter la [documentation de la 
+spécification](https://fabmob.github.io/standard-covoiturage/specification.html).
 À date, le standard s'appuye sur une
-[spécification OpenAPI (en)](./standard-covoiturage_openapi.yaml).
-Une documentation additionnelle est en cours de rédaction (cf. le
-[README du répertoire "doc"](./doc/README.fr.md)).
+[spécification OpenAPI (en)](./standard-covoiturage_openapi.yaml) disponible 
+sous forme d'une [documentation 
+swagger](https://fabmob.github.io/standard-covoiturage/specification.html).
 
 Le standard est publié en version informative (v1.0.0-alpha), pour permettre 
 une expérimentation avant publication en version normative. À ce titre, il est 

README.md

@@ -10,10 +10,13 @@ The "standard covoiturage" is intended to describe reference methods for
 making data available, carrying out transactions and, more generally, enabling 
 the exchange of services between carpooling operators and MaaS platforms.
 
+Please consult [the
+documentation of the 
+specification](https://fabmob.github.io/standard-covoiturage/).
 To date, the standard is based on an
-[OpenAPI specification](./standard-carpooling_openapi.yaml).
-Additional documentation is currently being written (see the
-[README of the "doc" directory](./doc/README.md)).
+[OpenAPI specification](./standard-carpooling_openapi.yaml), available as a
+[swagger 
+documentation](https://fabmob.github.io/standard-covoiturage/specification.html). 
 
 The standard is published in a draft version (v1.0.0-alpha), to allow an 
 experimentation before publication in a final version. As such, it might be 

docs/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+src/.vuepress/dist/

docs/.npmignore

@@ -0,0 +1,12 @@
+pids
+logs
+node_modules
+npm-debug.log
+coverage/
+run
+dist
+.DS_Store
+.nyc_output
+.basement
+config.local.js
+basement_dist