hope-country-report/mkdocs.yml at develop · unicef/hope-country-report · 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
copyright: Copyright &copy; 2020-2025 UNICEF
dev_addr: 127.0.0.1:8001
docs_dir: docs
edit_uri: 'blob/main/docs/'
repo_url: https://github.com/unicef/hope-country-report
site_author: HOPE Team
site_description: "Documentation"
site_dir: ./~build/docs
site_name: "Documentation"
site_url: https://unicef.github.io/hope-country-report/
strict: true
extra_css:
  - _theme/css/style.css
extra_javascript:
  - _theme/js/js.cookie.js
  - _theme/js/address.js
exclude_docs: |
  _docs/*
  _hooks/*
  _includes/*
  _scripts/*
  ~*

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: 'docs'
      check_paths: true
      url_download: true

extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

theme:
  name: "material"
  custom_dir: docs/_theme/overrides
  logo: _theme/img/logo.png
  favicon: _theme/img/favicon.ico
  color_mode: auto
  user_color_mode_toggle: true
  highlightjs: true
  hljs_languages:
    - yaml
    - django
  extra:
    version:
      provider: mike
      alias: true
  palette:
    - scheme: default
      primary: light blue
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    - scheme: slate
      primary: light blue
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - content.action.edit
    - content.code.copy
    - navigation.indexes
    - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress

plugins:
  - autorefs
  - awesome-pages:
      filename: .pages
      collapse_single_pages: true
      strict: false
      order: asc
      sort_type: natural
      order_by: title
  - ezglossary:
      templates: docs/_theme/glossary
      inline_refs: none
      list_definitions: true
      list_references: true
  - gitsnippet
  - link-marker
  - macros
  - include-markdown:
      encoding: ascii
      preserve_includer_indent: false
      dedent: false
      trailing_newlines: true
      comments: false
      rewrite_relative_urls: true
      heading_offset: 0
      recursive: true
  - privacy
  - search
  - social:
      cards_dir: assets/images/social
      cards_layout_options:
        font_family: Noto Sans SC
  - tags:
      # tags_file: tags.md
  - panzoom:
      full_screen: true

hooks:
  - docs/_hooks/hooks.py

validation:
  omitted_files: warn
  absolute_links: warn  # Or 'relative_to_docs' - new in MkDocs 1.6
  unrecognized_links: warn
  anchors: warn  # New in MkDocs 1.6