mkdocs-eds/mkdocs.yml at main · aphp/mkdocs-eds · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
site_name: mkdocs-eds
site_description: Showcase of the mkdocs-eds plugins and Markdown extensions.
repo_url: https://github.com/aphp/mkdocs-eds
repo_name: aphp/mkdocs-eds

theme:
  name: material
  language: en
  features:
    - navigation.tracking
    - navigation.instant
    - navigation.indexes
    - content.code.copy
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-7
        name: Switch to light mode

nav:
  - Home: index.md
  - Extensions:
      - Auto-generated reference: extensions/auto-gen-pages.md
      - Clickable code: extensions/clickable-code.md
      - Cards layout: extensions/cards.md
      - Pret snippet renderer: extensions/pret-snippets.md
      - Citations: extensions/citations.md
  - Reference: reference/

extra_css:
  - assets/stylesheets/extra.css

watch:
  - demo_package
  - docs

plugins:
  - auto_gen_pages:
      package_dirs:
        - demo_package
      reference_section: Reference
  - fix_fonts
  - cards
  - search
  - autorefs:
      priority:
        - "*"
        - reference
  - mkdocstrings_options_templates
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          options:
            docstring_style: numpy
            docstring_section_style: spacy
            members_order: source
            show_signature: false
            merge_init_into_class: true
  - bibtex:
      bibtex_file: "docs/references.bib"
  - clickable_code:
      repo_url: https://github.com/aphp/mkdocs-eds
  - pret_snippet_renderer

markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight
  - fenced_code
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

validation:
  absolute_links: ignore
  unrecognized_links: ignore