mirror of https://framagit.org/kyodev/kyopages.git
ajout dirty
This commit is contained in:
parent
ef52d27e46
commit
04c98f1d31
|
@ -1,13 +1,15 @@
|
|||
# essai mkdocs
|
||||
# test mkdocs
|
||||
|
||||
## 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/)
|
||||
* [Change log à partir 0.16](http://www.mkdocs.org/about/release-notes/#version-016-2016-11-04)
|
||||
|
||||
## install en local pour dev
|
||||
|
||||
ne pas utiliser apt, paquets outdated et localisation incompatible avec les themes additionnels
|
||||
** ne pas utiliser apt, paquet outdated et localisation incompatible avec les themes additionnels**
|
||||
```shell
|
||||
su
|
||||
pip install mkdocs
|
||||
|
@ -15,7 +17,9 @@ mkdocs --version
|
|||
# mkdocs, version 0.16.3
|
||||
exit
|
||||
```
|
||||
localisation sur programme
|
||||
|
||||
## localisation du programme
|
||||
|
||||
```text
|
||||
/usr/local/lib/python2.7/dist-packages/mkdocs
|
||||
/usr/local/lib/python2.7/dist-packages/mkdocs/assets/search/mkdocs
|
||||
|
@ -23,24 +27,29 @@ localisation sur programme
|
|||
/usr/local/bin/mkdocs
|
||||
/usr/share/mkdocs
|
||||
```
|
||||
installation d'un thème
|
||||
|
||||
## 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
|
||||
|
||||
## 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
|
||||
configurer git si besoin
|
||||
|
||||
* toutes la configuation et la déclaration des pages dans:
|
||||
```text
|
||||
mkdocs.yml
|
||||
```
|
||||
organisation pages
|
||||
|
||||
## organisation pages
|
||||
|
||||
```text
|
||||
mkdocs.yml
|
||||
docs/
|
||||
|
@ -48,14 +57,31 @@ docs/
|
|||
autre.md
|
||||
index.md
|
||||
...
|
||||
sites/
|
||||
# pages html générées
|
||||
```
|
||||
toutes la configuation, la déclaration des pages dans
|
||||
```text
|
||||
mkdocs.yml
|
||||
```
|
||||
démarrer serveur local, rafraîchissement automatique
|
||||
|
||||
### développement, build auto
|
||||
|
||||
* démarrer un serveur local, build et rafraîchissement automatique du navigateur
|
||||
```shell
|
||||
mkdocs serve
|
||||
```
|
||||
on peut utiliser
|
||||
```shell
|
||||
mkdocs serve --dirtyreload
|
||||
```
|
||||
mais le build sera sur la page uniquement, sans rechargement profond du navigateur (css notamment?). réserver au dev donc.
|
||||
|
||||
lancer **firefox** avec http://localhost:8000
|
||||
* lancer **firefox** sur http://localhost:8000
|
||||
|
||||
### build manuel
|
||||
|
||||
dans ce cas, un répertoire de pages html (site/) est créé à côté du répertoire des pages markdown (docs/ par défaut).
|
||||
ce répertoire _site_ est à poussé une site de pages statiques, à la différence de _docs_ où les pages doivent être
|
||||
générées en ligne.
|
||||
dans le même ordre d'idée, on peut utiliser:
|
||||
```shell
|
||||
mkdocs build --dirty
|
||||
```
|
||||
incidences à voir
|
||||
|
|
|
@ -0,0 +1,7 @@
|
|||
#!/bin/bash
|
||||
|
||||
# dirtyreload pour éviter de tout rebuilder à chaque changement, mais
|
||||
# comme moins en profondeur, tout ne sera pas forcément mis à jour,
|
||||
# réservé au développement.
|
||||
|
||||
x-terminal-emulator -e "bash -c 'mkdocs serve --dirtyreload'"
|
|
@ -0,0 +1,3 @@
|
|||
#!/bin/bash
|
||||
|
||||
x-terminal-emulator -e "bash -c 'mkdocs serve'"
|
Loading…
Reference in New Issue