Archives par mot-clé : Markdown

MKdocs pour un ReadTheDocs à partir d’un Markdown

Publié le par
Répondre

J’ai donc repris « mon CV » au format Markdown : https://github.com/farias06/resume .
Mais cette fois le but est de faire un ReadTheDocs avec mkdocs : https://mkdocs.readthedocs.io/en/0.10/ .

# apt-get install mkdocs
# apt-get install pip
# pip install mkdocs-mermaid2-plugin
# mkdocs build
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /.../site
INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
              - Competitions/Velo/README.md
WARNING  -  Documentation file 'README.md' contains a link to 'www.cyber-neurones.org' which is not found in the documentation files.
WARNING  -  Documentation file 'README.md' contains a link to 'descente-canyon.com' which is not found in the documentation files.
WARNING  -  Documentation file 'README.md' contains a link to 'descente-canyon.com' which is not found in the documentation files.
WARNING  -  Documentation file 'README.md' contains a link to 'descente-canyon.com' which is not found in the documentation files.
WARNING  -  Documentation file 'README.md' contains a link to 'descente-canyon.com' which is not found in the documentation files.
WARNING  -  Documentation file 'README.md' contains a link to 'descente-canyon.com' which is not found in the documentation files.
INFO     -  Documentation built in 0.67 seconds
# rm -rf /var/arias-frederic.org/public/*
# cp -r site/* /var/arias-frederic.org/public/.
# chown -R www-data.www-data /var/arias-frederic.org/public/

J’ai donc remplacé le site fait bien Hugo par le MKdocs.

Mais les emoji et le mermaid ne fonctionne pas pour l’instant.

J’ai donc ajouté :

  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

Cette fois cela marche mes les emojis sont énorme.

Au final c’est mieux d’avoir (moins pire) :

  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji

Pour le mermaid j’ai ajouté :

  - codehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format

extra_css:
  - https://unpkg.com/mermaid@8.5.1/dist/mermaid.css
extra_javascript:
  - https://unpkg.com/mermaid@8.5.1/dist/mermaid.min.js

Et cela fonctionne : https://my.cyber-neurones.org/ . Mais les emojis sont trop gros ….

A suivre.