rust-samp/mkdocs.yml at master · NullSablex/rust-samp · 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
site_name: rust-samp
site_description: Complete guide to building SA-MP and Open Multiplayer plugins with Rust
site_author: NullSablex
site_url: https://rust-samp.nullsablex.com/

repo_name: NullSablex/rust-samp
repo_url: https://github.com/NullSablex/rust-samp
edit_uri: edit/master/docs/

docs_dir: docs

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: orange
      toggle:
        icon: material/weather-night
        name: Dark theme
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: orange
      toggle:
        icon: material/weather-sunny
        name: Light theme
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_title: Permanent link
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Getting Started:
      - Setup and Installation: setup.md
      - Your First Plugin: first-plugin.md
  - Concepts:
      - Anatomy of a Plugin: plugin-anatomy.md
      - Open Multiplayer Support: omp-native.md
      - Native Functions: natives.md
      - The Amx Type: amx-types.md
      - Calling Pawn from Rust: exec-public.md
  - Working with Data:
      - Cells and Memory: cells-and-memory.md
      - String Encoding: encoding.md
      - Error Handling: error-handling.md
  - Development:
      - Logging and Debug: logging.md
      - VM Debugging: vm-debugging.md
      - Diagnostics: diagnostics.md
      - Build Scripts: build-scripts.md
      - Advanced Examples: advanced-examples.md
  - Reference:
      - Migration Guide: migration.md
      - API Reference: api-reference.md
  - Internals:
      - Open Multiplayer ABI: internals/omp-abi.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/NullSablex/rust-samp