Skip to content

Commit

Permalink
maj
Browse files Browse the repository at this point in the history
  • Loading branch information
Shevalier4444 committed Dec 24, 2023
1 parent 1313127 commit 11fb457
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 9 deletions.
10 changes: 9 additions & 1 deletion docs/page/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,12 @@ Pour réaliser un bouton on utilise la syntaxe suivante :
## Hébergement en local avec docker
On va donc utilise ici le docker qui nous fornie par [`material`](https://github.com/squidfunk/mkdocs-material), pour sa on utilise documentation de [`squidfunk/mkdocs-material`](https://hub.docker.com/r/squidfunk/mkdocs-material).
Pour l'installation on utilise la commande : `docker pull squidfunk/mkdocs-material`
Pour lancer le docker on utilise la commande : `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
Pour lancer le docker on utilise la commande : `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`

## Hebergement avec github pages
!!! info "Information"
Ce tuto est une méthode fonctionnelle de le faire et simple, des modifications y seront sûrement apportées pour le rendre plus fonctionnel et efficace.
Dans un premier temps, on doit générer la documentation en html avec la commande `mkdocs build` qui va générer la documentation dans le dossier `./site`. Puis, on va déplacer la documentation html vers le dossier `./` (racine) avec la commande `mv site/* .`.
!!! warning "Attention"
Il vous faudra peut-être supprimer certains dossiers de la racine comme `./img` ou `./page` pour que la commande `mv site/* .` marche correctement.
Puis, vous pourrez envoyer les modifications à github grâce à un `push` sur la page `main` et aussi de mettre à jour le git avec la commande `git push origin main`.
29 changes: 29 additions & 0 deletions page/documentation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#hebergement-avec-github-pages" class="md-nav__link">
<span class="md-ellipsis">
Hebergement avec github pages
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -530,6 +539,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#hebergement-avec-github-pages" class="md-nav__link">
<span class="md-ellipsis">
Hebergement avec github pages
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -640,6 +658,17 @@ <h2 id="hebergement-en-local-avec-docker">Hébergement en local avec docker</h2>
<p>On va donc utilise ici le docker qui nous fornie par <a href="https://github.com/squidfunk/mkdocs-material"><code>material</code></a>, pour sa on utilise documentation de <a href="https://hub.docker.com/r/squidfunk/mkdocs-material"><code>squidfunk/mkdocs-material</code></a>.<br />
Pour l'installation on utilise la commande : <code>docker pull squidfunk/mkdocs-material</code>
Pour lancer le docker on utilise la commande : <code>docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material</code></p>
<h2 id="hebergement-avec-github-pages">Hebergement avec github pages</h2>
<div class="admonition info">
<p class="admonition-title">Information</p>
<p>Ce tuto est une méthode fonctionnelle de le faire et simple, des modifications y seront sûrement apportées pour le rendre plus fonctionnel et efficace.</p>
</div>
<p>Dans un premier temps, on doit générer la documentation en html avec la commande <code>mkdocs build</code> qui va générer la documentation dans le dossier <code>./site</code>. Puis, on va déplacer la documentation html vers le dossier <code>./</code> (racine) avec la commande <code>mv site/* .</code>. </p>
<div class="admonition warning">
<p class="admonition-title">Attention</p>
<p>Il vous faudra peut-être supprimer certains dossiers de la racine comme <code>./img</code> ou <code>./page</code> pour que la commande <code>mv site/* .</code> marche correctement.</p>
</div>
<p>Puis, vous pourrez envoyer les modifications à github grâce à un <code>push</code> sur la page <code>main</code> et aussi de mettre à jour le git avec la commande <code>git push origin main</code>.</p>



Expand Down
Loading

0 comments on commit 11fb457

Please sign in to comment.