cms-docs-common/mkdocs.yml at main · cms-cat/cms-docs-common · 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
site_name: CMS Common Documentation
site_description: CMS Common Documentation
site_author: CERN Authoring
site_url: https://cms-docs-common.docs.cern.ch/
docs_dir: docs

repo_name: GitLab
repo_url: https://gitlab.cern.ch/cms-analysis/services/cms-docs-common
edit_uri: '-/edit/main/docs/'

nav:
  - Home: index.md

theme:
  name: material
  font: false
  palette:
    # Palette toggle for light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.top

markdown_extensions:
  - attr_list

plugins:
  - search
  - git-revision-date-localized
  - header-dropdown:
      config_file: "header-dropdown.yml"

# # [Legacy] If you want to use only one language for your documentation
# # and you don't want to configure it through the i18n plugin
# # you can still use the legacy configuration settings to do it
# # using the nav property as follows:

# nav:
#     - Introduction: index.md
#     - 'Chapter 1':
#       - 'Chapter 1': chapter1/file.en.md
#       - 'Chapter 1.1':
#         - 'Chapter 1.1': chapter1/subchapter1/subfile.en.md
#         - 'Chapter 1.1.1':
#           - 'Chapter 1.1.1': chapter1/subchapter1/subchapter1a/file1a.en.md
#           - 'Chapter 1.1.2': chapter1/subchapter1/subchapter1a/filewithimage.en.md
#     - 'Chapter 2': chapter2/index.en.md
#     - 'Interesting links': interesting_links/index.en.md
#     - 'MkDocs official documentation': https://www.mkdocs.org/

# # Notice that in this case, and since your documentation is not using
# # i18n plugin, you don't have to follow the convection filename.<language>.md
# # for your files. This is only required for using the i18n plugin. In addition,
# # for those users who want to use this configuration setting,
# # at least a file index.md is mandatory, so it has to be added or be renamed the current index.en.md.