Markdown lint configuration and fixes

Author: brunobesson

.markdownlint.json

@@ -0,0 +1,5 @@
+{
+  "default": true,
+  "MD013": { "line_length": 120},
+  "MD041": false
+}

.remarkrc

@@ -0,0 +1,6 @@
+{
+  "plugins": [
+    "remark-preset-lint-recommended",
+    ["remark-lint-list-item-indent", "space"]
+  ]
+}

TODO.md

@@ -1,4 +1,3 @@
-
 # Todo
 
 * maps
@@ -11,6 +10,7 @@
 
 * <https://github.com/c2corg/v6_api/issues/730>
   handle if token is obsolote or corrupted
+
 * no mail from c2c :
   * validate_new_password : callback when requestPasswordChange
   * validate_change_email

docs/development-environment.md

@@ -1,16 +1,17 @@
 
-Actually, it will much more comfortable to have an UI to manage every dev tasks. First of all, install [Vue CLI](https://cli.vuejs.org/)
+Actually, it will much more comfortable to have an UI to manage every dev tasks. First of all, install [Vue CLI](<https://cli.vuejs.org/>)
 
-```
+```bash
 npm install -g @vue/cli
 ```
 
 Then, simply launch :
-```
+
+```bash
 vue ui
 ```
 
-On http://localhost:8000, you will have on-click buttons for all features :
+On <http://localhost:8000>, you will have on-click buttons for all features :
 
 * `serve` : launch a ready-to-code server with hot reload
 * `build` : build a ready-to-deploy production site

public/README.md

@@ -1 +1,2 @@
-This folder contains [static files](https://cli.vuejs.org/guide/html-and-static-assets.html#static-assets-handling) referenced in `/src` by absolute path. Actually, it should not contains anything but index.html, and robots.txt. 
+This folder contains [static files](https://cli.vuejs.org/guide/html-and-static-assets.html#static-assets-handling)
+referenced in `/src` by absolute path. Actually, it should not contains anything but index.html, and robots.txt. 

src/assets/img/backgrounds/README.md

@@ -1,7 +1,10 @@
 The images in this directory are used as backgrounds in the homepage.
 
 They are provided courtesy of their authors with the following licences:
-* `alexbuisse-greenland.jpg` by Alex Buisse http://www.alexbuisse.com/ under a Creative Commons By NC SA license (https://creativecommons.org/licenses/by-nc-sa/3.0/deed)
-* `alexsaunier-monch.jpg` by Alex Saunier under a Creative Commons BY NC ND license (https://creativecommons.org/licenses/by-nc-nd/3.0/deed)
-* `laurentf-sajama.jpg` by Laurent F http://lolofreg2.over-blog.com/ under a Creative Commons BY NC ND license (https://creativecommons.org/licenses/by-nc-nd/3.0/deed)
-* `cermygian-crevasse.jpg` by cermygian https://www.camptocamp.org/profiles/279741/en under a Creative Commons By NC SA license (https://creativecommons.org/licenses/by-nc-sa/3.0/deed) Original image: https://www.camptocamp.org/images/566097/en/glacier-du-geant-m-blanc
+
+* `alexbuisse-greenland.jpg` by Alex Buisse <http://www.alexbuisse.com/> under a Creative Commons By NC SA license (<https://creativecommons.org/licenses/by-nc-sa/3.0/deed>)
+* `alexsaunier-monch.jpg` by Alex Saunier under a Creative Commons BY NC ND license (<https://creativecommons.org/licenses/by-nc-nd/3.0/deed>)
+* `laurentf-sajama.jpg` by Laurent F <http://lolofreg2.over-blog.com/> under a Creative Commons BY NC ND license (<https://creativecommons.org/licenses/by-nc-nd/3.0/deed>)
+* `cermygian-crevasse.jpg` by cermygian <https://www.camptocamp.org/profiles/279741> under a Creative Commons By NC SA
+  license (<https://creativecommons.org/licenses/by-nc-sa/3.0/deed>) Original image:
+  <https://www.camptocamp.org/images/566097/en/glacier-du-geant-m-blanc>

src/components/README.md

@@ -1,11 +1,11 @@
 This folder contains all Vue components.
 
-They are grouped by common behavior that share same children components :
+They are grouped by common behavior that share same children components:
 
-* cards : card component that display a card, given a camptocamp documents
+* cards: card component that display a card, given a camptocamp documents
 * datatable
-* generics : generic components available everywhere. Simply add a .vue file here, and you can use it everywhere
-* helper : modal window that show a helper. Simply call `this.$helper.show(helperId)` in your component.
-* imagesUploader : upload image to a document
-* map : map component
-* markddownEditor : does it needs an explanation ?
+* generics: generic components available everywhere. Simply add a .vue file here, and you can use it everywhere
+* helper: modal window that show a helper. Simply call `this.$helper.show(helperId)` in your component.
+* imagesUploader: upload image to a document
+* map: map component
+* markdownEditor: does it needs an explanation ?

src/views/wiki/edition/README.md

@@ -1,4 +1,4 @@
-Edition views, one per document's type
+# Edition views, one per document's type
 
 ## Some infos
 
@@ -9,12 +9,12 @@ What is the logic behind field distribution in edition views ?
 What is the logic behind field distribution in edition views ?
 
 1. first tab, called "General informations"
-  * all mandatory fields
-  * and the shortest possible list of most used fields.
+    * all mandatory fields
+    * and the shortest possible list of most used fields.
 2. then, in other tabs
-  * Ideally, this tab must not have vertical scroll  
-  * fields with common sense are kept together, on the same row if possible
-  * then, rows are ordered by useness
+    * Ideally, this tab must not have vertical scroll  
+    * fields with common sense are kept together, on the same row if possible
+    * then, rows are ordered by useness
 
 ### Ergonomics targets
 

src/views/wiki/edition/utils/README.md

@@ -1,27 +1,28 @@
 Utilities for edition views.
 
-### form-row
+# form-row
+
 A row with two parts :
 
 * on left side, a label
 * on right side, one or more inputs
 
-This row will be visible if, and only if at least one of its children has `visible property set to `true`
+This row will be visible if, and only if at least one of its children has `visible` property set to `true`
 
-#### Attributes
+## Attributes
 
 * `label`, a mandatory string
 * `always-visible`, optional boolean
 * `is-grouped`, optional boolean, set it to true if you have severals inputs, and you need them to be sticked
 
-#### Usage
+## Usage
 
-``` HTML
+```html
 <!-- with two inputs -->
 <form-row :label="$gettext('waypoint')" is-grouped>
     <form-input :document="document" :field="fields.waypoint_type"/>
     <form-input :document="document" :field="fields.title"/>
-</form-row>        
+</form-row>
 
 <!-- with one input, always visible -->
 
@@ -31,16 +32,16 @@ This row will be visible if, and only if at least one of its children has `visib
 </form-row>
 ```
 
-### form-simple-row
+# form-simple-row
 
 ``` HTML
 <form-simple-row :document="document" :field="fields.title" />
 ```
 
-### form-input
+# form-input
 
 ``` HTML
 <form-input :document="document" :field="fields.title"/>
 ```
 
-TODO : rname everyting 
+TODO : rname everyting