RetroAchievementsSharp/mkdocs.yml at master · purelogiccode/RetroAchievementsSharp · 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
site_name: RetroAchievementsSharp
site_description: >-
  A native C# port of the RAHasher 1.8.3 CLI that produces 100% identical
  RetroAchievements hashes, evolved to track rcheevos 12.4.0 as the single
  source of truth.
site_url: https://purelogiccode.github.io/RetroAchievementsSharp/
repo_url: https://github.com/purelogiccode/RetroAchievementsSharp
edit_uri: blob/master/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: cyan
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - toc:
      permalink: true

extra:
  generator: false

copyright: >
  GPL-2.0-or-later — Copyright (c) 2026 Peterson Fernandes and Pure Logic
  Code. The ported core is the MIT-licensed rcheevos engine (credited in
  THIRD-PARTY-NOTICES.md). RAHasher reference material is GPL-3.0 and is
  never shipped.

nav:
  - Home: index.md
  - Getting Started:
      - getting-started/installation.md
      - getting-started/usage.md
      - getting-started/publishing.md
  - Architecture:
      - architecture/overview.md
      - architecture/engine.md
      - architecture/cartridge.md
      - architecture/disc.md
      - architecture/zip.md
      - architecture/encrypted.md
      - architecture/cli.md
      - architecture/parity-harness.md
  - Development:
      - development/testing.md
      - development/oracles.md
      - development/porting-guide.md
      - development/logging.md
      - development/sync-rcheevos.md
      - development/documentation.md
  - Reference:
      - reference/console-table.md
      - reference/hashing-semantics.md
      - reference/public-api.md
      - reference/known-quirks.md
      - reference/parity-evidence.md
  - Release Notes: ReleaseNotes.md
  - License: license.md