mirror of https://framagit.org/kyodev/kyopages.git
66 lines
1.5 KiB
Markdown
66 lines
1.5 KiB
Markdown
# essai mkdocs
|
|
|
|
## kyopages
|
|
|
|
[sur framagit](https://kyodev.frama.io/kyopages/)
|
|
|
|
## liens
|
|
* [gitlab.com/pages/mkdocs](https://gitlab.com/pages/mkdocs)
|
|
* [Les Gitlab Pages débarquent dans Framagit !](https://framablog.org/2017/03/20/les-gitlab-pages-debarquent-dans-framagit/)
|
|
* [www.mkdocs.org](http://www.mkdocs.org/)
|
|
|
|
## install en local pour dev
|
|
|
|
ne pas utiliser apt, paquet outdated et localisation incompatible avec les themes additionnels
|
|
```shell
|
|
su
|
|
pip install mkdocs
|
|
mkdocs --version
|
|
# mkdocs, version 0.16.3
|
|
exit
|
|
```
|
|
localisation sur programme
|
|
```text
|
|
/usr/local/lib/python2.7/dist-packages/mkdocs
|
|
/usr/local/lib/python2.7/dist-packages/mkdocs/assets/search/mkdocs
|
|
/usr/local/lib/python2.7/dist-packages/mkdocs/themes/mkdocs
|
|
/usr/local/bin/mkdocs
|
|
/usr/share/mkdocs
|
|
```
|
|
installation d'un thème
|
|
```shell
|
|
pip install mkdocs-material
|
|
#localisation: /usr/local/lib/python2.7/dist-packages/material
|
|
```
|
|
pour info, création d'un nouveau site
|
|
```shell
|
|
mkdocs new kyopages
|
|
cd kyopages
|
|
# configurer git si besoin
|
|
```
|
|
construction manuelle
|
|
```shell
|
|
mkdocs build
|
|
# inutile si serveur en route, surveillance automatique des changements
|
|
# reconstruction, rafraîchissement du navigateur
|
|
```
|
|
organisation pages
|
|
```text
|
|
mkdocs.yml
|
|
docs/
|
|
autreDirectory/
|
|
autre.md
|
|
index.md
|
|
...
|
|
```
|
|
toutes la configuation, la déclaration des pages dans
|
|
```text
|
|
mkdocs.yml
|
|
```
|
|
démarrer serveur local, rafraîchissement automatique
|
|
```shell
|
|
mkdocs serve
|
|
```
|
|
|
|
lancer **firefox** avec http://localhost:8000
|