mkdocs-badges/mkdocs.yml at main · six-two/mkdocs-badges · 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
site_name: mkdocs-badges
repo_url: https://github.com/six-two/mkdocs-badges

theme:
  name: material
  features:
    - content.code.copy
    - navigation.footer
    - navigation.expand
nav:
# Hide the index page -> would otherwise result in two mkdocs-badges links
- "": index.md
- setup.md
- badge-types.md
- badge-syntax.md
- styling.md
- migration.md
- "Tests":
  - test/basic.md
  - test/install.md
  - test/invalid.md
  - test/tags.md
  - test/theme.md
  - test/basic-caret-separator.md
  - test/issues.md
  - test/inline-badges.md

plugins:
- search
- badges:
    tag_page_link: /test/tags/
    install_badge_data: tests/extra-install-badges.json
    # ignore_lines_starting_with_whitespace: true
    # async: False
    # disable_warnings: True

    # # For testing new inline badges
    # separator: ";"
    # table_separator: "$"
    # inline_badge_start: "<"
    # inline_badge_end: ">"
# - tags

# SEE https://squidfunk.github.io/mkdocs-material/reference/admonitions/
markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true


extra_css:
- assets/stylesheets/custom.css