diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0d11611 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Build files +site/ + +# Do not lock deps +Pipfile.lock diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000..351f5e3 --- /dev/null +++ b/Pipfile @@ -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" diff --git a/README.md b/README.md index 4478850..36b795e 100644 --- a/README.md +++ b/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. + diff --git a/docs/imprimantes-3d.md b/docs/imprimantes-3d.md new file mode 100644 index 0000000..af53de7 --- /dev/null +++ b/docs/imprimantes-3d.md @@ -0,0 +1,3 @@ +# Les imprimantes 3D du [kro]bot + +TODO diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e789ea1 --- /dev/null +++ b/docs/index.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..1feb4a9 --- /dev/null +++ b/mkdocs.yml @@ -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 +