Documentation mkdocs initiale
This commit is contained in:
parent
57825f0eb3
commit
4b188d350b
6 changed files with 71 additions and 0 deletions
5
.gitignore
vendored
Normal file
5
.gitignore
vendored
Normal file
|
@ -0,0 +1,5 @@
|
|||
# Build files
|
||||
site/
|
||||
|
||||
# Do not lock deps
|
||||
Pipfile.lock
|
13
Pipfile
Normal file
13
Pipfile
Normal file
|
@ -0,0 +1,13 @@
|
|||
[[source]]
|
||||
name = "pypi"
|
||||
url = "https://pypi.org/simple"
|
||||
verify_ssl = true
|
||||
|
||||
[dev-packages]
|
||||
|
||||
[packages]
|
||||
mkdocs = "*"
|
||||
mkdocs-material = "*"
|
||||
|
||||
[requires]
|
||||
python_version = "3.6"
|
19
README.md
19
README.md
|
@ -1,2 +1,21 @@
|
|||
# KrobotDocumentation
|
||||
|
||||
Toute la documentation liée au Krobot
|
||||
|
||||
## Compiler la documentation chez soi
|
||||
|
||||
Il faut installer `mkdocs` et `mkdocs-material`.
|
||||
Ensuite dans le dossier vous pouvez simplement appeler `mkdocs serve`.
|
||||
|
||||
Pour simplifier le travail, vous pouvez juste utiliser Pipenv.
|
||||
|
||||
```
|
||||
pipenv install
|
||||
pipenv run mkdocs serve
|
||||
```
|
||||
|
||||
## TODO
|
||||
|
||||
* Placer une favicon.ico dans docs/img ;
|
||||
* Migrer l'ancien site.
|
||||
|
||||
|
|
3
docs/imprimantes-3d.md
Normal file
3
docs/imprimantes-3d.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# Les imprimantes 3D du [kro]bot
|
||||
|
||||
TODO
|
6
docs/index.md
Normal file
6
docs/index.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
# Bienvenue aventurier [kro]botien !
|
||||
|
||||
Ce site a pour but d'héberger l'ensemble de la documentation relative
|
||||
au matériel que vous pourrez trouver dans nos locaux.
|
||||
|
||||
Krobotiquement vôtre.
|
25
mkdocs.yml
Normal file
25
mkdocs.yml
Normal file
|
@ -0,0 +1,25 @@
|
|||
site_name: "[kro]bot"
|
||||
site_description: Le club de robotique de l'ENS Paris-Saclay
|
||||
copyright: "Copyright © Krobot 2019"
|
||||
repo_url: https://github.com/ens-krobot/KrobotDocumentation/
|
||||
nav:
|
||||
- Accueil: index.md
|
||||
- Matériel:
|
||||
- Imprimante 3D: imprimantes-3d.md
|
||||
extra:
|
||||
search:
|
||||
language: 'en, fr'
|
||||
social:
|
||||
- type: github
|
||||
link: https://github.com/ens-krobot
|
||||
theme:
|
||||
name: material
|
||||
language: fr
|
||||
palette:
|
||||
primary: 'light green'
|
||||
accent: 'light green'
|
||||
logo: images/logo.svg
|
||||
font: false
|
||||
feature:
|
||||
tabs: true
|
||||
|
Loading…
Reference in a new issue