cachi2/mkdocs.yml at main · a-ovchinnikov/cachi2 · 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
# Project information
site_name: Hermeto
repo_name: hermetoproject/hermeto
repo_url: https://github.com/hermetoproject/hermeto
edit_uri: edit/main/docs

# Theme configuration
theme:
  name: material
  locale: en
  palette:
    - scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-5
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.tooltips
    - navigation.sections
    - search.share
    - search.suggest

# Navigation bar
nav:
  - Home: index.md
  - Usage: usage.md
  - Package managers:
      - bundler: bundler.md
      - cargo: cargo.md
      - generic: generic.md
      - gomod: gomod.md
      - npm: npm.md
      - pip: pip.md
      - rpm: rpm.md
      - yarn classic: yarn_classic.md
      - yarn berry: yarn.md

# Markdown extensions
markdown_extensions:
  - footnotes
  - pymdownx.emoji
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - toc:
      permalink: true

# Markdown validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

# Irrelevant files
exclude_docs: |
  dependency_confusion.md
  adr/
  design/