Skip to content
Snippets Groups Projects
Commit 71a9ea6a authored by ddamiron's avatar ddamiron
Browse files

add md files hierarchy configuration using mkdocs.yml

parent 77e11ddc
No related branches found
No related tags found
1 merge request!1Mkdocs material
......@@ -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.
......
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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment