04 MkDocs

MKDocs¶

Installation¶

mkdir mkdocs
cd mkdocs
docker pull squidfunk/mkdocs-material

Modifier le fichier DockerFile afin d'ajouter les plugins

FROM squidfunk/mkdocs-material
RUN pip install mkdocs-plugin-tags pymdown-extensions https://pypi.org/project/mkdocs-nbconvert/

docker build .

Modifier le fichier de configuration mkdocs.yml

site_name: MathGon
theme:
  name: material
  language: fr
  logo: http://www.mathgon.com/wp/wp-content/themes/lysa/images/header.png
  palette:
    primary: light blue
  font:
    text: Titillium Web
extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/mathgon
  generator: false
plugins:
  - search

docker run --name mkdocs --rm -it -p 8118:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Warning

Un peu en galère pour installer le plugins de tags

  docker run --rm -it --entrypoint /bin/sh squidfunk/mkdocs-material

puis

  pip list

Lancer le container

docker run --name mkdocs --rm -it -p 8118:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Attention: si mise àjour du Dockerfile pour intégrer lancerla commande

docker build --rm .
docker run --name mkdocs --rm -it -p 8118:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Syntaxe¶

!!! 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

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.

abstract, summary, tldr info, todo tip, hint, important success, check, done question, help, faq warning, caution, attention failure, fail, missing danger, error bug example quote, cite