UID-Docs/mkdocs.yml at main · FactionsU/UID-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


# Project information
site_name: 'FactionsUUID'
site_description: 'Premium Factions for premium people.'
site_author: 'MOSS'
site_url: 'https://factions.support/'

# Repository
repo_name: 'GitHub'
repo_url: 'https://github.com/FactionsU/UID'
edit_uri: 'edit/main/docs/'

# Copyright
copyright: 'Copyright &copy; 2019-2025'

# Configuration
theme:
  name: 'material'
  custom_dir: overrides
  language: 'en'
  palette:
    scheme: 'slate'
    primary: 'green'
    accent: 'light green'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'
  features:
    - navigation.instant
    - navigation.instant.prefetch

extra_css:
  - stylesheets/dark_theme.css
  - stylesheets/codehilite.css

# Page tree
nav:
  - Home: index.md
  - Support: help.md
  - Project News: news/index.md
  - The Big 4.0 Update: four.md
  - Introduction: introduction.md
  - Definitions: definitions.md
  - First Steps: firststeps.md
  - Chat Formatting: chat.md
  - Commands: commands.md
  - Permissions: permissions.md
  - Permission Nodes: permissionnodes.md
  - Permission Contexts: contexts.md
  - Placeholders: placeholders.md
  - PlaceholderAPI: placeholderapi.md
  - Particles: particles.md
  - Upgrades: upgrades.md
  - Developers: developers.md

# Customization
extra:
  social:
    - icon: 'fontawesome/brands/discord'
      link: 'https://discord.gg/PHpuzZS'
  fuuidversion: 4.4.0

# Plugins
plugins:
  - blog:
      blog_dir: news
  - search


# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      guess_lang: false
  - md_in_html
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: true