Addons/mkdocs.yml at master · Andre601/Addons · 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
site_name: Andre_601's Add-ons
site_description: 'A collection of all my Add-ons for ItemsAdder and CosmeticsCore'
site_author: 'Andre_601'
site_url: 'https://addons.andre601.ch' # Uncomment to set a canonical URL

copyright: |
  &copy; Andre_601

docs_dir: docs/

repo_name: Andre601/Addons
repo_url: https://github.com/Andre601/Addons
#edit_uri: tree/master/docs # Uncomment to define a different URI/URL for the "edit" option

watch:
  - theme

theme:
  name: 'material'
  custom_dir: 'theme'
  favicon: 'assets/images/favicon.png'
  logo: 'assets/images/favicon.png'
  palette:
    scheme: 'slate'
    primary: 'deep purple'
    accent: 'indigo'
  #font:
  #  text: 'Roboto'
  #  code: 'Roboto Mono'
  #language: 'en'
  #direction: 'ltr'
  features:
  # Announce
  #
  #- announce.dismiss # Adds a "X" button to dismiss a news banner/mark it as read.*
  #- header.autohide # Hide header when user scrolls past a specific point.
  #- navigation.expand      # Expand all collapsable sections.
  #- navigation.instant     # Instant loading pages.
  - navigation.indexes     # Attach pages directly to Sections. Incompatible with "toc.integrate"
  - navigation.sections    # Render top sections as groups.
  - navigation.tabs         # Render top sections as tabs at the top.
  - navigation.tabs.sticky # Tabs won't disappear when scrolling down. Requires "navigation.tabs".
  - navigation.top         # Adds a "Back to top" that is shown when scrolling up.
  #- navigation.tracking    # Updates the url with highlighted section anchor.
  #- search.highlight # Search will highlight the searched word(s) on the page.*
  #- search.share     # Adds an option to share a search query link.*
  #- search.suggest   # Search will suggest the likeliest completion for a word.*
  #- toc.integrate          # Include the TOC sections in the left navugation.

  icon:
    repo: 'octicons/mark-github-16'

  #admonition:
  #    note: 'octicons/tag-16'
  #    abstract: 'octicons/checklist-16'
  #    info: 'octicons/info-16'
  #    tip: 'octicons/squirrel-16'
  #    success: 'octicons/check-16'
  #    question: 'octicons/question-16'
  #    warning: 'octicons/alert-16'
  #    failure: 'octicons/x-circle-16'
  #    danger: 'octicons/zap-16'
  #    bug: 'octicons/bug-16'
  #    example: 'octicons/beaker-16'
  #    quote: 'octicons/quote-16'

extra_css:
  - assets/stylesheets/admonitions.css
  - assets/stylesheets/colors.css
#extra_javascript:

extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/Andre601/Addons'

  #generator: true
  #manifest: manifest.webmanifest
  #alternate:

markdown_extensions:
  - markdown.extensions.admonition:
  - markdown.extensions.toc:
      permalink: true
  - markdown.extensions.attr_list
  - pymdownx.details:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
  - pymdownx.magiclink:
  - pymdownx.superfences:
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path:
        - 'docs/assets/snippets'

plugins:
  - search
  - glightbox
  - awesome-pages
  - pagenav-generator