Skip to content
Snippets Groups Projects
Commit f5ecde18 authored by Nicolas Castejon's avatar Nicolas Castejon
Browse files

Merge branch 'mkdocs_material' into 'master'

update README file

See merge request refonte-data/documentation!2
parents eeb6b4ae cdc36338
Branches
No related tags found
1 merge request!2update README file
Pipeline #1035 passed
# Portail Data documentation # Portail Data documentation
\ No newline at end of file
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `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.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
\ No newline at end of file
# Welcome to the functional documentation of portail-data # Welcome to the functional documentation of portail-data
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `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.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
...@@ -4,6 +4,9 @@ site_author: MkDocs Team ...@@ -4,6 +4,9 @@ site_author: MkDocs Team
theme: theme:
name: 'material' name: 'material'
palette:
primary: 'grey'
accent: 'amber'
nav: nav:
- Home: index.md - Home: index.md
...@@ -15,7 +18,9 @@ nav: ...@@ -15,7 +18,9 @@ nav:
- Monitoring: architecture/monitoring.md - Monitoring: architecture/monitoring.md
- Web-app: architecture/web-app.md - Web-app: architecture/web-app.md
- Service: - Service:
- authentification: architecture/service/autentification.md - authentification: architecture/service/authentication.md
- organizations: architecture/service/organizations.md
- resources: architecture/service/resources.md
- Elasticsearch: - Elasticsearch:
- Indexer: architecture/service/elasticsearch/indexer.md - Indexer: architecture/service/elasticsearch/indexer.md
- About: - About:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment