update docs

botflux · Oct 3, 2021 · 9eecb1e · 9eecb1e
1 parent 77c80d5
commit 9eecb1e
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 16 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -12,19 +12,40 @@ module.exports = {
         displayAllHeaders: true,
         sidebar: [
             {
-                title: "Guide",
-                path: "/guide/",
-                collapsable: false,
-                sidebarDepth: 2,
-                children: [
-                    "/guide/",
-                    "/guide/installation.md",
-                    "/guide/usages.md",
-                    "/guide/augment-configuration-factory.md",
-                    "/guide/write-a-loader.md",
-                    "/guide/write-a-parser.md",
-                    "/guide/write-a-validator.md",
-                ]
+                title: "Installation",
+                path: "/guide/installation.md",
+                collapsable: true,
+                sidebarDepth: 1,
+            },
+            {
+                title: "Usages",
+                path: "/guide/usages.md",
+                collapsable: true,
+                sidebarDepth: 1,
+            },
+            {
+                title: "Augment configuration factory",
+                path: "/guide/augment-configuration-factory.md",
+                collapsable: true,
+                sidebarDepth: 1,
+            },
+            {
+                title: "Write a configuration loader",
+                path: '/guide/write-a-loader.md',
+                collapsable: true,
+                sidebarDepth: 1
+            },
+            {
+                title: "Write a configuration parser",
+                path: '/guide/write-a-parser.md',
+                collapsable: true,
+                sidebarDepth: 1
+            },
+            {
+                title: "Write a configuration validator",
+                path: '/guide/write-a-validator.md',
+                collapsable: true,
+                sidebarDepth: 1
             }
         ]
     },

diff --git a/docs/guide/installation.md b/docs/guide/installation.md
@@ -18,6 +18,7 @@ npm install --save @configuration-parsing/parser-toml
 npm install --save @configuration-parsing/parser-yaml
 npm install --save @configuration-parsing/parser-jsonc
 npm install --save @configuration-parsing/validator-joi
+npm install --save @configuration-parsing/validator-ajv
 ```
 
 ## Available parsers
@@ -28,24 +29,43 @@ Shipped in `@configuration-parsing/core`.
 
 ### Toml
 
-[npmjs.org](https://www.npmjs.com/package/@configuration-parsing/parser-toml)
+[npmjs.com](https://www.npmjs.com/package/@configuration-parsing/parser-toml)
 
 ```shell
 npm install --save @configuration-parsing/parser-toml
 ```
 
 ### Yaml
 
-[npmjs.org](https://www.npmjs.com/package/@configuration-parsing/parser-yaml)
+[npmjs.com](https://www.npmjs.com/package/@configuration-parsing/parser-yaml)
 
 ```shell
 npm install --save @configuration-parsing/parser-yaml
 ```
 
 ### Jsonc
 
-[npmjs.org](https://www.npmjs.com/package/@configuration-parsing/parser-jsonc)
+[npmjs.com](https://www.npmjs.com/package/@configuration-parsing/parser-jsonc)
 
 ```shell
 npm install --save @configuration-parsing/parser-jsonc
 ```
+
+## Available validators
+
+### Joi
+
+[npmjs.com](https://www.npmjs.com/package/@configuration-parsing/validator-joi)
+
+```shell
+npm install --save @configuration-parsing/validator-joi
+```
+
+### Ajv
+
+[npmjs.com](https://www.npmjs.com/package/@configuration-parsing/validator-ajv)
+
+```shell
+npm install --save @configuration-parsing/validator-ajv
+```
+