Syriinge/mkdocs.yml at main · Sammi-Husky/Syriinge · 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
site_name: "Syriinge Documentation"
site_url: "https://syriinge.sammihusky.com"
repo_url: https://github.com/Sammi-Husky/Syriinge
repo_name: "Sammi-Husky/Syriinge"
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2023 - 2025 Sammi Husky
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Sammi-Husky/Syriinge
theme:
  name: "material"
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    logo: fontawesome/solid/syringe
  palette:
    scheme: "slate"
    primary: "green"
    accent: "green"
  features:
    - navigation.top
    - navigation.indexes
    - content.action.edit
    - navigation.instant
    - navigation.instant.progress
markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - tables
  - 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.details

nav:
  - Home: index.md
  - Getting Started:
      - Quick Start Guide: getting-started/quick-start.md
      - Tutorial: getting-started/tutorial.md
  - API:
      - API/index.md
      - CoreAPI: API/CoreAPI.md
      - PluginMeta: API/PluginMeta.md
      - Hooks:
          - syInlineHook: API/hooks/inline-hook.md
          - syInlineHookRel: API/hooks/inline-hook-rel.md
          - syReplaceFunc: API/hooks/replace-func.md
          - syReplaceFuncRel: API/hooks/replace-func-rel.md
          - sySimpleHook: API/hooks/simple-hook.md
          - sySimpleHookRel: API/hooks/simple-hook-rel.md
      - Events:
          - ModuleLoadEvent: API/events/ModuleLoadEvent.md
  - Guides:
      - Inline Hooking: guides/inline-hook.md
      - Replacing Functions: guides/replace-func.md
      - Simple Hooks: guides/simple-hook.md
      - Plugin Meta: guides/plugin-meta.md
      - Event Handling: guides/event-handling.md
      - Writing to Memory: guides/writing-to-memory.md
      - Patch Files: guides/patch-files.md
  - Patch Files: "patches.md"
  - Technical Documentation:
      - Syriinge Overview: technical/syriinge-overview.md
      - Plugin System: technical/plugin-system.md
      - Hooking System: technical/hooking-system.md
      - Patching System: technical/patching-system.md
      - Syriinge Loader: technical/syriinge-loader.md