kyopages/docs/about/about.md

1.5 KiB

essai mkdocs

kyopages

sur framagit

liens

install en local pour dev

ne pas utiliser apt, paquet outdated et localisation incompatible avec les themes additionnels

su
pip install mkdocs
mkdocs --version
	# mkdocs, version 0.16.3
exit

localisation sur programme

	/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

pip install mkdocs-material
	#localisation: /usr/local/lib/python2.7/dist-packages/material

pour info, création d'un nouveau site

mkdocs new kyopages
cd kyopages
# configurer git si besoin

construction manuelle

mkdocs build
# inutile si serveur en route, surveillance automatique des changements
# reconstruction, rafraîchissement du navigateur

organisation pages

mkdocs.yml
docs/
	autreDirectory/
		autre.md
	index.md
	...

toutes la configuation, la déclaration des pages dans

mkdocs.yml

démarrer serveur local, rafraîchissement automatique

mkdocs serve

lancer firefox avec http://localhost:8000