esx-framework.github.io/mkdocs.yml at development · Re-Ignited-Development/esx-framework.github.io · 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
104
105
106
site_name: ESX Documentation
site_description: Official ES Extended Documentation
site_author: ES Extended Development Team

# Repository
repo_name: ESX Framework
repo_url: https://github.com/esx-framework/
edit_uri: ""

# Copyright
copyright: Copyright &copy; 2017-2022 ESX Framework

# Configuration
docs_dir: docs
site_dir: site
strict: true

# Theme
theme:
  name: material
  custom_dir: overrides

  # 404 Page
  static_templates:
    - 404.html

  # Don't include MKDoc's JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    - tabs
  palette:
    scheme: slate
    primary: blue
    accent: blue
  font:
    text: Fira Sans
    code: Fira Mono
  icon:
    logo: material/school
    repo: fontawesome/brands/github-alt
  favicon: assets/images/favicon.png

# Plugins
plugins:
  - search
  - awesome-pages

# Social
extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/esx-framework
    - icon: fontawesome/brands/discord
      link: https://discord.gg/ztzKWAF

# Extensions
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.codehilite:
      guess_lang: false
      linenums: true
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      provider: 'github'
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      labels:
        {

          'commit': 'Commit',
          'compare': 'Compare',
          'issue': 'Issue',
          'pr': 'Pull Request',
          'mention': 'User',
          'repo': 'Repository'

        }
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde