ALL Update to apply markdown linter - docs-guideline

fluatovh · Mar 26, 2020 · f917a9e · f917a9e
1 parent 66162b8
commit f917a9e
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 23 deletions.
diff --git a/docs-guideline/docs-guideline.md b/docs-guideline/docs-guideline.md
@@ -11,7 +11,7 @@ All guides are stored in this [repository](#)
 
 A `guide` belongs to a `product` that belongs to an `universe`. Keep this in mind :).
 
-```
+```bash
 .
 ├── pages
 |   ├── web
@@ -45,12 +45,13 @@ _example_: `home.en-gb.md`, `universe.fr-fr.md`, ...
 #### content-types
 
 ##### home
+
 Home page for a specific `zone` and `language` pair.
 No content in this file except metadata.
 
 ###### available metadata
 
-| name    | description                      | extra                  | 
+| name    | description                      | extra                  |
 |---------|----------------------------------|------------------------|
 | title   | title of the site                | mandatory              |
 | excerpt | short desc of the site           |                        |
@@ -70,7 +71,8 @@ Page that lists all visible products the universe owns.
 No content in this file except metadata.
 
 ###### available metadata
-| name    | description                      | extra                  | 
+
+| name    | description                      | extra                  |
 |---------|----------------------------------|------------------------|
 | title   | title of the product             | mandatory              |
 | excerpt | short desc of the universe       |                        |
@@ -85,7 +87,7 @@ No content in this file except metadata.
 
 ###### available metadata
 
-| name    | description                      | extra                  | 
+| name    | description                      | extra                  |
 |---------|----------------------------------|------------------------|
 | title   | title of the product             | mandatory              |
 | excerpt | short desc of the product        |                        |
@@ -99,7 +101,7 @@ Page containing documentation about the subject of your choice.
 
 ###### metadata
 
-| name    | description                      | extra                  | 
+| name    | description                      | extra                  |
 |---------|----------------------------------|------------------------|
 | title   | title of the doc                 | mandatory              |
 | excerpt | short desc of the doc            |                        |
@@ -112,7 +114,7 @@ Page containing documentation about the subject of your choice.
 
 If you want to add some pictures in your guide, create a folder images within your guide folder and place your pics there.
 
-```
+```bash
 ...
 ├── my-super-guide
 |   ├── images
@@ -132,6 +134,7 @@ You can now reference your pics relatively to your guide. See below an example f
 Each guide must be placed in a folder with a representative name
 
 #### languages
+
 Allowed `ISO 639-1` language code (*[wikipedia](https://en.wikipedia.org/wiki/ISO_639-1)*)
 
 - `cs`: Czech
@@ -147,6 +150,7 @@ Allowed `ISO 639-1` language code (*[wikipedia](https://en.wikipedia.org/wiki/IS
 - `pt`: Portuguese
 
 #### zones
+
 Allowed `ISO 3166-1` country code (*[wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1)*)
 
 - `au`: Australia
@@ -172,6 +176,6 @@ ___
 
 ## Format
 
-All ressources are written in `markdown`. [See examples](http://commonmark.org/help/)
+All ressources are written in `markdown`. [See examples](http://commonmark.org/help/).
 
-In order to write specific content, we extend the base syntax to fit our needs. [see examples](markdown-custom.md)
+In order to write specific content, we extend the base syntax to fit our needs. [See examples](markdown-custom.md).
diff --git a/docs-guideline/markdown-custom.md b/docs-guideline/markdown-custom.md
@@ -5,7 +5,7 @@
 
 ### alert
 
-```
+```md
 /* markdown */
 
 > [!alert]
@@ -24,11 +24,11 @@
 
 ![alert notice](images/notice-alert.png)
 
-### Other notices: 
+### Other notices
 
 #### primary
 
-```
+```md
 /* markdown */
 
 > [!primary]
@@ -41,7 +41,7 @@
 
 #### warning
 
-```
+```md
 /* markdown */
 
 > [!warning]
@@ -54,7 +54,7 @@
 
 #### info
 
-```
+```md
 /* markdown */
 
 > [!info]
@@ -65,10 +65,9 @@
 
 ![alert notice](images/notice-simple.png)
 
-
 ## Carousel
 
-```
+```md
 /* markdown */
 
 > [!carousel]
@@ -80,7 +79,7 @@
 ```
 
 ```html
-<!-- generated html --> 
+<!-- generated html -->
 
 <div class="carousel">
     <div>
@@ -102,7 +101,7 @@
 
 ## FAQ
 
-```
+```md
 /* markdown */
 
 > [!faq]
@@ -122,7 +121,7 @@
 ```
 
 ```html
-<!-- generated html --> 
+<!-- generated html -->
 
 <dl class="docutils">
     <dt><em>Question 1</em></dt>
@@ -168,7 +167,7 @@
 
 ## Api
 
-```
+```md
 /* markdown */
 
 > [!api]
@@ -178,7 +177,7 @@
 ```
 
 ```html
-<!-- generated html --> 
+<!-- generated html -->
 
 <div class="ovh-api-main">
   <a href="https://eu.api.ovh.com/console/#/ipLoadbalancing/{serviceName}/tcp/route#POST" target="_blank">
@@ -190,12 +189,11 @@
 
 ![api](images/api.png)
 
-
 ## Advanced
 
 You can mix different custom syntax
 
-```
+```md
 /* markdown */
 
 > [!faq]
@@ -269,4 +267,4 @@ You can mix different custom syntax
 </dl>
 ```
 
-![custom](images/custom.jpg)
+![custom](images/custom.jpg)