Skip to content
Extraits de code Groupes Projets
mkdocs.yml 4,16 ko
Newer Older
Mireille COILHAC's avatar
Mireille COILHAC a validé
site_name: "Modèle de site avec Python"
Mireille COILHAC's avatar
Mireille COILHAC a validé
site_description: Un modèle avec mkdocs

site_url: !ENV [CI_PAGES_URL, "http://127.0.0.1:8000/"]
site_author: !ENV [CI_COMMIT_AUTHOR, "Nom d'auteur"]
repo_url: !ENV [CI_PROJECT_URL]
edit_uri: !ENV [EDIT_VARIABLE]
Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé
copyright: |
    Association <a href="https://aeif.fr">AEIF</a>
    <a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/deed.fr"><img alt="Licence Creative Commons" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br/>
    Hébergé sur la forge gérée par l'<a href="https://aeif.fr">AEIF</a>

Mireille COILHAC's avatar
Mireille COILHAC a validé

Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé
docs_dir: docs
Mireille COILHAC's avatar
Mireille COILHAC a validé

Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé
nav:
Mireille COILHAC's avatar
Mireille COILHAC a validé
  - "🏡 Accueil": index.md
Mireille COILHAC's avatar
Mireille COILHAC a validé
  - ... | regex=^(?:(?!_REM.md).)*$
Mireille COILHAC's avatar
Mireille COILHAC a validé

Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé

theme:
Mireille COILHAC's avatar
Mireille COILHAC a validé
    favicon: assets/favicon.ico
    icon:
      logo: material/application-variable
    custom_dir: my_theme_customizations/
Mireille COILHAC's avatar
Mireille COILHAC a validé
    name: material
    font: false                     # RGPD ; pas de fonte Google
    language: fr                    # français
    palette:                        # Palettes de couleurs jour/nuit
      - media: "(prefers-color-scheme: light)"
        scheme: default
        primary: indigo
        accent: indigo
        toggle:
            icon: material/weather-sunny
            name: Passer au mode nuit
      - media: "(prefers-color-scheme: dark)"
        scheme: slate
        primary: blue
        accent: blue
        toggle:
            icon: material/weather-night
            name: Passer au mode jour
    features:
        - navigation.instant
Mireille COILHAC's avatar
Mireille COILHAC a validé
        # - navigation.tabs   Pour avoir le menu vertical il faut supprimer ça
Mireille COILHAC's avatar
Mireille COILHAC a validé
        - navigation.top
        - toc.integrate
        - header.autohide

Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé

markdown_extensions:
Mireille COILHAC's avatar
Mireille COILHAC a validé
    - meta
    - abbr

    - def_list                      # Les listes de définition.
    - attr_list                     # Un peu de CSS et des attributs HTML.
    - footnotes                     # Notes[^1] de bas de page.  [^1]: ma note.
    - admonition                    # Blocs colorés  !!! info "ma remarque"
    - pymdownx.details              #   qui peuvent se plier/déplier.
    - pymdownx.caret                # Passage ^^souligné^^ ou en ^exposant^.
    - pymdownx.mark                 # Passage ==surligné==.
    - pymdownx.tilde                # Passage ~~barré~~ ou en ~indice~.
    - pymdownx.highlight:           # Coloration syntaxique du code
        auto_title: true
        auto_title_map:
            "Python": "🐍 Script Python"
            "Python Console Session": "🐍 Console Python"
            "Text Only": "📋 Texte"
            "E-mail": "📥 Entrée"
            "Text Output": "📤 Sortie"
    - pymdownx.inlinehilite         # pour  `#!python  <python en ligne>`
    - pymdownx.snippets             # Inclusion de fichiers externe.
    - pymdownx.tasklist:            # Cases à cocher  - [ ]  et - [x]
        custom_checkbox:    false   #   avec cases d'origine
        clickable_checkbox: true    #   et cliquables.
    - pymdownx.tabbed:              # Volets glissants.  === "Mon volet"
        alternate_style: true 

    - pymdownx.keys:                # Touches du clavier.  ++ctrl+d++
        separator: "\uff0b"
    - pymdownx.emoji:               # Émojis  :boom:
        emoji_index:     !!python/name:materialx.emoji.twemoji
        emoji_generator: !!python/name:materialx.emoji.to_svg


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



    - pymdownx.arithmatex:
        generic: true
    - toc:
        permalink: ⚓︎
        toc_depth: 2
        - icon: fontawesome/regular/envelope
          link: mailto:votre.mail@ac-academie.fr
          name: Écrire à l'auteur
Mireille COILHAC's avatar
Mireille COILHAC a validé

        - icon: fontawesome/brands/gitlab
          link: !ENV [CI_PROJECT_ROOT_NAMESPACE]
Mireille COILHAC's avatar
Mireille COILHAC a validé

Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé

plugins:
  - search
Mireille COILHAC's avatar
Mireille COILHAC a validé
  - awesome-pages:
        collapse_single_pages: true
  - tags:
      tags_file: tags.md
Mireille COILHAC's avatar
Mireille COILHAC a validé
  
Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé

extra_javascript:
  - xtra/javascripts/mathjax-config.js                    # MathJax
Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - xtra/stylesheets/qcm.css ##
  - xtra/stylesheets/ajustements.css  # ajustements