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

update README file

update banner color using mkdocs.yml
parent 71a9ea6a
No related branches found
No related tags found
1 merge request!2update README file
# Portail Data documentation
\ No newline at end of file
# Portail Data documentation
## 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
## 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
theme:
name: 'material'
palette:
primary: 'grey'
accent: 'amber'
nav:
- Home: index.md
......@@ -15,7 +18,9 @@ nav:
- Monitoring: architecture/monitoring.md
- Web-app: architecture/web-app.md
- Service:
- authentification: architecture/service/autentification.md
- authentification: architecture/service/authentication.md
- organizations: architecture/service/organizations.md
- resources: architecture/service/resources.md
- Elasticsearch:
- Indexer: architecture/service/elasticsearch/indexer.md
- About:
......
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