decky-romm-sync/mkdocs.yml at main · danielcopper/decky-romm-sync · 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
site_name: decky-romm-sync
site_description: A Decky Loader plugin that syncs your self-hosted RomM library into Steam
site_url: https://danielcopper.github.io/decky-romm-sync/

# Architectural Decision Records (`docs/adr/`) are kept in the repo for
# contributors and AI agents — they're internal design history, not user
# documentation. Exclude them from the published MkDocs site so they
# don't appear as orphan pages or in on-site search.
exclude_docs: |
  adr/

repo_url: https://github.com/danielcopper/decky-romm-sync
repo_name: danielcopper/decky-romm-sync
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.code.copy

extra_css:
  - stylesheets/extra.css

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.details

nav:
  - Home: index.md
  - User Guide:
      - Getting Started: user-guide/getting-started.md
      - Configuration: user-guide/configuration.md
      - Syncing Your Library: user-guide/syncing-your-library.md
      - Managing Games: user-guide/managing-games.md
      - BIOS &amp; Emulator Cores: user-guide/bios-management.md
      - Save Sync: user-guide/save-sync.md
      - Save File Extensions: user-guide/save-file-extensions.md
      - Save Sync Support Matrix: user-guide/save-sync-support-matrix.md
      - RetroDECK Path Migration: user-guide/retrodeck-path-migration.md
      - Troubleshooting: user-guide/troubleshooting.md
  - Architecture:
      - Backend Architecture: architecture/backend-architecture.md
      - Database Design: architecture/database-design.md
      - Save File Sync Architecture: architecture/save-file-sync-architecture.md
      - Save Sync Coverage: architecture/save-sync-coverage.md
      - Config Source Parsers: architecture/config-source-parsers.md
      - Core &amp; Emulator Selection: architecture/core-emulator-selection.md
      - Steam Non-Steam Shortcuts: architecture/steam-non-steam-shortcuts.md
      - Steam Remote Play & Cross-Device: architecture/steam-remote-play.md
  - Contributing:
      - Development: contributing/development.md
      - Frontend dev loop: contributing/frontend-dev-loop.md
      - Dependency management: contributing/dependency-management.md