8.5 KiB
Welcome to MkDocs
For full documentation visit mkdocs.org.
Take me to pookie
Take me to [pookie](macos/python/pip.md#Environnement virtuel:)
Installation:
$ pip install mkdocs
Commandes:
mkdocs new [dir-name]- Create a new project.mkdocs serve- Start the live-reloading docs server.mkdocs build- Build the documentation site.mkdocs help- Print this help message.gh-deploy- Deploy your documentation to GitHub Pages.
Project layout:
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Créer un nouveau projet de docs:
bruno@SilverBook:~$ mkdocs new project
INFO - Creating project directory: project
INFO - Writing config file: project/mkdocs.yml
INFO - Writing initial docs: project/docs/index.md
bruno@SilverBook:~$ cd project
total 8
drwxr-xr-x 4 bruno staff 128 16 déc 20:48 .
drwxr-xr-x@ 70 bruno staff 2240 16 déc 20:48 ..
drwxr-xr-x 3 bruno staff 96 16 déc 20:48 docs
-rw-r--r-- 1 bruno staff 19 16 déc 20:48 mkdocs.yml
Servir le projet:
bruno@SilverBook:~/project$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 171216 20:54:40 server:283] Serving on http://127.0.0.1:8000
[I 171216 20:54:40 handlers:60] Start watching changes
[I 171216 20:54:40 handlers:62] Start detecting changes
[I 171216 20:55:00 handlers:133] Browser Connected: http://127.0.0.1:8000/
[I 171216 20:55:41 handlers:133] Browser Connected: http://127.0.0.1:8000/
Copier les docs sur le serveur:
$ cd /Users/bruno/project
$ ./build_and_upload.sh
/build_and_upload.sh
# !/bin/bash
cd /Users/bruno/project
mkdocs build
scp -P42666 -r ./central_docs bruno@192.168.xxx.xxx:/volume1/web
Admonitions:
Note:
Note simple:
!!! note ""
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa.
!!! note "" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Note avec titre:
!!! note "Phasellus posuere in sem ut cursus"
!!! note "Phasellus posuere in sem ut cursus" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Note sans titre:
!!! note ""
!!! note "" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Note avec contenu:
!!! note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. python def bubble_sort(items): for i in range(len(items)): for j in range(len(items) - 1 - i): if items[j] > items[j + 1]: items[j], items[j + 1] = items[j + 1], items[j] Nunc eu odio eleifend, blandit leo a, volutpat sapien. Phasellus posuere in sem ut cursus. Nullam sit amet tincidunt ipsum, sit amet elementum turpis. Etiam ipsum quam, mattis in purus vitae, lacinia fermentum enim.
Note collapsible ouverte:
??? note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
??? note Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Note collapsible fermée:
???+ note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
???+ note Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Type:
abstract, summary, tldr
!!! abstract "Résumé"
!!! abstract "Résumé" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
info, todo
!!! info "Info"
!!! info "Info" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
tip, hint, important
!!! tip "Tip"
!!! tip "Tip" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
success, check, done
!!! success "Succès"
!!! success "Succès" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
question, help, faq
!!! help "Aide"
!!! help "Aide" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
warning, caution, attention
!!! warning "Attention"
!!! warning "Attention" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
failure, fail, missing
!!! fail "Echec"
!!! fail "Echec" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
danger, error
!!! danger "Erreur"
!!! danger "Erreur" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
bug
!!! bug "Bug"
!!! bug "Bug" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
example
!!! example "Exemple"
!!! example "Exemple" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
quote, cite
!!! quote "Citation"
!!! quote "Citation" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
https://squidfunk.github.io/mkdocs-material/reference/abbreviations/
Font Awesome icons:
:fa-link: http://bwmarrin.github.io/MkDocsPlus/
:fa-link: http://fontawesome.io/icons/
:fa-link:
:fa-link:
<i class="fa fa-link fa-lg"></i>
<i class="fa fa-link fa-2x"></i>
<i class="fa fa-link fa-5x"></i>
Themes:
Installer un thème:
$ pip install mkdocs-cinder
Mettre à jour un thème:
$ pip install --upgrade mkdocs-material
:octicons-link: Material for MkDocs
https://github.com/otsuarez/mkdocs_auth
/Users/bruno/Documents/venv/mkdocs/bin/pip3 install