satchel/mkdocs.yml at main · ryanlua/satchel · 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
site_name: Satchel Documentation
site_url: https://satchel.luau.page/
repo_name: ryanlua/satchel
repo_url: https://github.com/ryanlua/satchel

copyright: Copyright 2026 &copy; Ryan Luu

theme:
  name: material
  features:
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.top
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/github
  favicon: assets/favicon.svg
  logo: assets/logo.svg
  custom_dir: docs/overrides

extra:
  version:
    provider: mike
  social:
    - icon: simple/github
      link: https://github.com/ryanlua/satchel
      name: GitHub
    - icon: simple/roblox
      link: https://create.roblox.com/store/asset/13947506401
      name: Creator Store
    - icon: simple/robloxstudio
      link: https://devforum.roblox.com/t/2451549
      name: DevForum
    - icon: simple/discord
      link: https://discord.gg/N2KEnHzrsW
      name: Discord

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.highlight:
      linenums: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Introduction: introduction.md
  - Installation: installation.md
  - Usage: usage.md
  - Platforms: platforms.md
  - Alternatives: alternatives.md
  - API Reference: api-reference.md