Docs/mkdocs.yml at master · AtlanticBot/Docs · 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
site_name: PurrBot Documentation
site_description: 'API-Documentation and Wiki of *Purr*'
site_author: 'Andre_601'

site_url: 'https://docs.purrbot.site'

copyright: |
  Docs made with
  <img alt="❤" class="twemoji heart-anim md-footer-custom-text" src="https://twemoji.maxcdn.com/v/latest/svg/2764.svg" title="love">
  and provided under the
  <a href="https://github.com/purrbot-site/Docs/blob/master/LICENSE" target="_blank">MIT-License</a>.

docs_dir: docs/

repo_name: purrbot-site/PurrBot
repo_url: https://github.com/purrbot-site/PurrBot
edit_uri: https://github.com/purrbot-site/Docs/edit/master/docs

nav:
  - Welcome: index.md
  - API:
    - ImageAPI: api/index.md
  - Bot:
    - General:
      - Welcome: bot/index.md
      - Commands: bot/commands.md
      - FAQ: 'https://purrbot.site/discord'
      - Selfhosting: bot/selfhosting.md
    - Welcome-System:
      - Setup: bot/welcome-channel.md
      - Images: bot/welcome-images.md
  - Contributing:
    - Contribute: contribute/index.md
    - Formatting Help: contribute/formatting-help.md
    - Translations: contribute/translate.md
  - Credits:
    - Credits: credits.md
  - Legal:
    - Info: legal/index.md
    - Bot: legal/bot.md
    - API: legal/api.md
    - Website: legal/website.md

theme:
  name: 'material'
  custom_dir: 'theme'
  logo: 'assets/img/logo.png'
  favicon: 'assets/img/logo.png'
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: cyan
      accent: blue
      toggle:
        icon: octicons/sun-24
        name: "Switch to Dark Mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: cyan
      accent: blue
      toggle:
        icon: octicons/moon-24
        name: "Switch to Light Mode"
  features:
  - navigation.tabs
  - navigation.sections
  - navigation.top
  icon:
    repo: fontawesome/brands/github-square

extra_css:
  - 'assets/css/extra.css'

extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/purrbot-site'
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/TruePurrBot'

markdown_extensions:
  - attr_list
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
  - meta
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.details
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg