leadr-docs/mkdocs.yml at main · LEADR-official/leadr-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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
site_name: LEADR Docs
site_url: https://docs.leadr.gg
site_description: Documentation for LEADR - the cross-platform leaderboard backend for indie game developers
site_author: LEADR
theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo.png
  favicon: assets/favicon.ico
  font:
    text: Figtree
    code: Roboto Mono
  palette:
    # Light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - content.code.copy
plugins:
  - search
  - autorefs
  - section-index
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - toc:
      permalink: true
exclude_docs: |
  *.sw*

site_dir: site-md

nav:
  - Overview: index.md
  - Quick Start: quick-start.md
  - LEADR:
      - Features: features.md
      - Guides:
          - Install the LEADR App: guides/install.md
          - Register an Account: guides/register.md
          - Create Your First Game: guides/create-game.md
          - Create Your First Board: guides/create-board.md
          - Advanced Boards: guides/advanced-boards.md
          - Inviting Teammates: guides/invites.md
          - Join a Team: guides/join.md
          - Get the SDK: guides/get-sdk.md
          - Use LEADR in Your Game: guides/use-sdk.md
          - Go Live Checklist: guides/go-live-checklist.md
          - View Your Boards Online: guides/board-pages.md
          - Review Flagged Scores: guides/review-score-flags.md
          - Upgrade Your Plan: guides/upgrading.md
          - Manage Your Subscription: guides/subscription-management.md
      - Reference:
          - Games: reference/games.md
          - Boards: reference/boards.md
          - Board Templates: reference/board-templates.md
          - Anti-Cheat System: reference/anti-cheat.md
  - SDKs:
      - Overview: sdks/index.md
      - Unity:
          - Overview: sdks/unity/index.md
          - Reference: sdks/unity/reference.md
      - Godot:
          - Overview: sdks/godot/index.md
          - Reference: sdks/godot/reference.md
      - "C#": sdks/c-sharp/index.md
      - Unreal: sdks/unreal/index.md
      - REST API:
          - Reference: api/client-api.md
          - Authentication: api/client-auth.md
  - LEADR OSS:
      - Overview: api/leadr-open-source.md
      - Self Host: api/self-host.md
      - Admin API:
          - Overview: api/index.md
          - Patterns: api/patterns.md
          - Pagination: api/pagination.md
          - HTTP API: api/http-api/index.md
          - Reference: api/reference/index.md
  - About: about.md
  - Roadmap: roadmap.md
  - Changelog: changelog.md

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/RMUukcAxSZ
      name: LEADR Discord Server
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/leadr-official.bsky.social
      name: LEADR on Bluesky
    - icon: fontawesome/brands/mastodon
      link: https://mastodon.social/@LEADR_official
      name: LEADR on Mastodon
    - icon: fontawesome/brands/reddit
      link: https://www.reddit.com/r/LEADR/
      name: LEADR on Reddit
    - icon: fontawesome/brands/github
      link: https://github.com/LEADR-official
      name: LEADR on GitHub