From 71a9ea6a9988867853b6b614670348b41d03220c Mon Sep 17 00:00:00 2001
From: ddamiron <ddamiron@sii.fr>
Date: Tue, 11 Jun 2019 16:08:41 +0200
Subject: [PATCH] add md files hierarchy configuration using mkdocs.yml
---
docs/index.md | 17 +++++++++++++++++
mkdocs.yml | 23 ++++++++++++++++++++++-
2 files changed, 39 insertions(+), 1 deletion(-)
diff --git a/docs/index.md b/docs/index.md
index 9b45a3a..62049be 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -7,6 +7,23 @@
* `mkdocs build` - Build the documentation site.
* `mkdocs help` - Print this help message.
+## Setting files hierarchy
+ inside mkdocs.yml use the key nav: to configure the md files hierarchy
+
+ nav:
+ - Home: index.md
+ - Architecture Guide:
+ - Admin-gui: architecture/admin-gui.md
+ - Admin-tools: architecture/admin-tools.md
+ - Api-gateway: architecture/api-gateway.md
+ - CMS: architecture/cms.md
+ - Monitoring: architecture/monitoring.md
+ - Web-app: architecture/web-app.md
+ - Service:
+ - authentification: architecture/service/autentification.md
+ - Elasticsearch:
+ - Indexer: architecture/service/elasticsearch/indexer.md
+
## Project layout
mkdocs.yml # The main file and configuration file.
diff --git a/mkdocs.yml b/mkdocs.yml
index 919dff8..378eda7 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,3 +1,24 @@
-site_name: portail data functional documentation
+site_name: Portail Data Functional Documentation
+site_description: Portail Data Project Documentation with Markdown.
+site_author: MkDocs Team
+
theme:
name: 'material'
+
+nav:
+ - Home: index.md
+ - Architecture Guide:
+ - Admin-gui: architecture/admin-gui.md
+ - Admin-tools: architecture/admin-tools.md
+ - Api-gateway: architecture/api-gateway.md
+ - CMS: architecture/cms.md
+ - Monitoring: architecture/monitoring.md
+ - Web-app: architecture/web-app.md
+ - Service:
+ - authentification: architecture/service/autentification.md
+ - Elasticsearch:
+ - Indexer: architecture/service/elasticsearch/indexer.md
+ - About:
+ - Gitflow: miscellaneous/gitflow-ci-cd.md
+ - VSCode: miscellaneous/vscode-settings.md
+ - Webapp: miscellaneous/webapp-auth.md
--
GitLab