site_name: RomM

docs_dir: docs

site_url: https://docs.romm.app/

site_author: RomM Team

site_description: Your beautiful, powerful, self-hosted ROM manager

repo_url: https://github.com/rommapp/romm

repo_name: rommapp/romm

edit_uri: edit/main/docs/

# Snippet sources live under docs/ so pymdownx.snippets can include them, but

# they are not standalone pages. Exclude them from the build so they don't get

# rendered or indexed by search (inclusion still works via snippets base_path).

exclude_docs: |

resources/snippets/

theme:

name: material

logo: resources/romm/isotipo.png

favicon: resources/romm/isotipo.png

features:

- navigation.instant

- navigation.instant.prefetch

- navigation.footer

- navigation.indexes

- navigation.tracking

- navigation.top

- search.suggest

- search.highlight

- content.tabs.link

- content.code.annotation

- content.code.copy

- version

language: en

palette:

# Dark mode

- scheme: slate

toggle:

icon: material/toggle-switch

name: Switch to light mode

primary: custom

accent: custom

# Light mode

- scheme: default

toggle:

icon: material/toggle-switch-off-outline

name: Switch to dark mode

primary: custom

accent: custom

version:

provider: mike

custom_dir: overrides

plugins:

- search

- mkdocs-video

- asciinema-player

- social:

cards_layout_options:

font_family: Roboto

background_color: "#371f69"

color: "#ede5f8"

logo: docs/assets/romm/romm-logo.png

title: RomM Docs

description: Your beautiful, powerful, self-hosted ROM manager

- glightbox:

skip_classes:

- skip-lightbox

- markdownextradata: {}

- literate-nav:

nav_file: Navigation.md

- git-revision-date-localized:

enable_creation_date: true

type: timeago

- mike

- redirects:

redirect_maps:

# Getting Started → new IA

Getting-Started/Quick-Start-Guide.md: getting-started/quick-start.md

Getting-Started/Configuration-File.md: reference/configuration-file.md

Getting-Started/Environment-Variables.md: reference/environment-variables.md

Getting-Started/Metadata-Providers.md: getting-started/metadata-providers.md

Getting-Started/OIDC-Setup.md: administration/oidc/index.md

Getting-Started/Reverse-Proxy.md: install/reverse-proxy.md

Getting-Started/Authentication.md: administration/authentication.md

# Platforms and Players

Platforms-and-Players/Supported-Platforms.md: platforms/supported-platforms.md

Platforms-and-Players/EmulatorJS-Player.md: using/in-browser-play/emulatorjs.md

Platforms-and-Players/RuffleRS-Player.md: using/in-browser-play/ruffle.md

Platforms-and-Players/MS-DOS.md: using/in-browser-play/ms-dos.md

Platforms-and-Players/Custom-Platforms.md: platforms/custom-platforms.md

# System Setup → Install

System-Setup/Unraid-Setup-Guide.md: install/unraid.md

System-Setup/Unraid-Compose-Setup.md: install/unraid.md

System-Setup/Synology-Setup-Guide.md: install/synology.md

System-Setup/TrueNAS-Setup-Guide.md: install/truenas.md

# Usage → split into Administration + Using

Usage/LibraryManagement.md: using/index.md

Usage/UserManagement.md: administration/users-and-roles.md

Usage/Administration.md: administration/index.md

# OIDC Guides

OIDC-Guides/OIDC-Setup-With-Authelia.md: administration/oidc/authelia.md

OIDC-Guides/OIDC-Setup-With-Authentik.md: administration/oidc/authentik.md

OIDC-Guides/OIDC-Setup-With-Keycloak.md: administration/oidc/keycloak.md

OIDC-Guides/OIDC-Setup-With-PocketID.md: administration/oidc/pocketid.md

OIDC-Guides/OIDC-Setup-With-Zitadel.md: administration/oidc/zitadel.md

# API & Development

API-and-Development/index.md: developers/index.md

API-and-Development/API-Reference.md: developers/api-reference.md

API-and-Development/Development-Setup.md: developers/development-setup.md

API-and-Development/Contributing.md: developers/contributing.md

# Tools → Ecosystem

Tools/Igir-Collection-Manager.md: ecosystem/igir.md

# Ecosystem → Developers (moved)

ecosystem/client-api-tokens.md: developers/client-api-tokens.md

ecosystem/ssh-sync.md: developers/ssh-sync.md

# Core Concepts merged into Glossary

getting-started/concepts.md: reference/glossary.md

# Metadata Providers moved into Getting Started

administration/metadata-providers.md: getting-started/metadata-providers.md

# Docker Compose reference folded into Quick Start

install/docker-compose.md: getting-started/quick-start.md

# Maintenance

Maintenance/Scheduled-Tasks.md: administration/scheduled-tasks.md

Maintenance/Migrating-to-new-machine.md: install/backup-and-restore.md

# Integrations → Ecosystem

Integrations/Playnite-plugin.md: ecosystem/first-party-apps.md

Integrations/muOS-app.md: ecosystem/first-party-apps.md#grout

Integrations/Tinfoil-integration.md: ecosystem/feed-clients.md#tinfoil

Integrations/pkgj-integration.md: ecosystem/feed-clients.md#pkgj

# Troubleshooting (just casing change)

Troubleshooting/Scanning-Issues.md: troubleshooting/scanning.md

Troubleshooting/Authentication-Issues.md: troubleshooting/authentication.md

Troubleshooting/Synology-Issues.md: troubleshooting/synology.md

Troubleshooting/Kubernetes-Issues.md: troubleshooting/kubernetes.md

# Miscellaneous → About

Miscellaneous/FAQs.md: about/faqs.md

Miscellaneous/Brand-Guidelines.md: about/brand-guidelines.md

markdown_extensions:

- pymdownx.blocks.caption

- pymdownx.highlight:

anchor_linenums: true

- pymdownx.inlinehilite

- pymdownx.snippets:

base_path:

- docs

- docs/resources/snippets

check_paths: true

- admonition

- pymdownx.arithmatex:

generic: true

- footnotes

- pymdownx.details

- pymdownx.superfences

- pymdownx.mark

- md_in_html

- attr_list

- tables

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

copyright: Copyright © 2025 RomM Team

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/rommapp/romm

name: rommapp/romm

- icon: fontawesome/brands/discord

link: https://discord.com/invite/romm

name: RomM Discord Channel

- icon: fontawesome/solid/globe

link: https://romm.app/

name: romm.app

version:

provider: mike

alias: true

extra_css:

- resources/css/theme.css

watch:

- docs

- docs/resources