36 lines
1.8 KiB
Markdown
Executable File
36 lines
1.8 KiB
Markdown
Executable File
<p align="center">
|
|
<img src="https://git.djeex.fr/Djeex/DjeexLab/raw/branch/main/docs/files/img/global/lab.svg" align="center" width="700">
|
|
|
|
|
|
[](https://docs.djeex.fr/) [](https://discord.gg/jvhardware) [](https://docs.djeex.fr/)
|
|
|
|
</p>
|
|
# 🔧 De la doc, encore de la doc
|
|
**Djeex Lab** c'est avant tout un projet personnel visant à héberger chez soi le plus de services possibles du quotidien sans passer par des plateformes propriétaires (Google, Apple, Netflix...). Cette doc utilise [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
|
|
|
|
Ce repo contient de quoi modifier les pages, ajouter vos changements, et redéployer le site.
|
|
|
|
# Tester avec docker
|
|
|
|
Le `compose.yaml` vous permet de déployer le conteneur et un environnement de test joignable directement via `http://ipduserveur:8005`. Modifiez le `compose.yaml` selon votre environnement.
|
|
|
|
Déployez le avec docker, en vous positionnant dans le dossier `mkdocs` avec la commande
|
|
```console
|
|
$ sudo docker compose up -d
|
|
```
|
|
Les changements effectués sur les documents sont répercutés en temps réel sur le serveur web.
|
|
|
|
> [!WARNING]
|
|
> N'utilisez pas le serveur web du conteneur pour de la production.
|
|
|
|
# Build le site
|
|
|
|
Le site statique est stocké dans `/site`. Pour le build, veuillez utiliser la commande suivante
|
|
|
|
```console
|
|
$ sudo docker exec -i -w /docs mkdocs mkdocs build
|
|
```
|
|
|
|
Veuillez penser à le faire avant de demander un merge.
|
|
|
|
Un grand merci à **Nipah** et **Xenio**, pour le partage de leurs connaissances infinies, et surtout pour leur patience. |