diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed72ee9..decc517 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,7 @@ We use [mike](https://github.com/jimporter/mike) to build and deploy documentati uv run mike deploy --push --update-aliases [alias] ``` -This will update the `gh-pages` branch and automatically deploys the version with the fix/update to https://docs.romm.app +This will update the `gh-pages` branch and automatically deploys the version with the fix/update to . ## Pull Request Guidelines diff --git a/README.md b/README.md index 76578c1..6e6961e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ + + +
RomM docs logo diff --git a/docs/Getting-Started/Authentication.md b/docs/Getting-Started/Authentication.md index 5a184ba..1a12cd6 100644 --- a/docs/Getting-Started/Authentication.md +++ b/docs/Getting-Started/Authentication.md @@ -1,3 +1,5 @@ + + RomM provides support for various forms of authentication, granting flexibility in securing access to its features. ### Setup diff --git a/docs/Getting-Started/Configuration-File.md b/docs/Getting-Started/Configuration-File.md index b4850d5..34fbd1b 100644 --- a/docs/Getting-Started/Configuration-File.md +++ b/docs/Getting-Started/Configuration-File.md @@ -1,3 +1,6 @@ + + + Below is a breakdown of each section of the `config.yml` file and its purpose: ### `exclude` diff --git a/docs/Getting-Started/Environment-Variables.md b/docs/Getting-Started/Environment-Variables.md index 92b6cd5..996d0fc 100644 --- a/docs/Getting-Started/Environment-Variables.md +++ b/docs/Getting-Started/Environment-Variables.md @@ -1,3 +1,5 @@ + + This is a complete list of available environment variables; required variables are marked with a `✓`. @@ -89,5 +91,5 @@ This is a complete list of available environment variables; required variables a ## Development | DEV_MODE | Enable development mode (debugging, hot-reloading) | | `false` | -| DEV_HOST | Host for development server | | `| DEV_PORT | Port for development server | |`5000` | -| DEV_SQL_ECHO | Enable SQL query logging in development mode | |`false` | +| DEV_HOST | Host for development server | | | `DEV_PORT` | Port for development server | |`5000` | +| DEV_SQL_ECHO | Enable SQL query logging in development mode | |`false` | diff --git a/docs/Getting-Started/Folder-Structure.md b/docs/Getting-Started/Folder-Structure.md index 8b2932a..4f248cd 100644 --- a/docs/Getting-Started/Folder-Structure.md +++ b/docs/Getting-Started/Folder-Structure.md @@ -1,5 +1,6 @@ + RomM requires one of these folder structures for proper operation. It will first attempt to detect **Structure A (recommended)**, and if not found, will fall back to **Structure B**. This auto-detection ensures flexibility while encouraging organization best practices. diff --git a/docs/Getting-Started/Metadata-Providers.md b/docs/Getting-Started/Metadata-Providers.md index f8084c6..3796c29 100644 --- a/docs/Getting-Started/Metadata-Providers.md +++ b/docs/Getting-Started/Metadata-Providers.md @@ -1,3 +1,6 @@ + + + RomM supports multiple metadata providers to enrich your game library with titles, descriptions, cover art, and achievements. You don't need all providers, so this guide covers [popular combos](#popular-combos) and [setup instructions](#setup-instructions). ## Popular combos diff --git a/docs/Getting-Started/Quick-Start-Guide.md b/docs/Getting-Started/Quick-Start-Guide.md index 18abced..461e06a 100644 --- a/docs/Getting-Started/Quick-Start-Guide.md +++ b/docs/Getting-Started/Quick-Start-Guide.md @@ -1,4 +1,6 @@ + + This quick start guide will help you get a RomM instance up and running. It is split into 3 parts: @@ -22,7 +24,6 @@ This guide will assume that you already have the following done, if not - stop h Now that we have everything gathered, we can begin getting your instance set up! - 1. Download a copy of the latest docker-compose.example.yml file from GitHub 3. Edit the file and modify the following values to configure the database - `MARIADB_ROOT_PASSWORD`: Sets the root password of the database. Use a unique and secure password (_use a password generator for simplicity_) @@ -84,7 +85,6 @@ Now that we have everything gathered, we can begin getting your instance set up! 2. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page 3. Go through the setup wizard, setting your admin username and password 4. Log in with the credentials you set in the last step - ## Configure diff --git a/docs/Getting-Started/Reverse-Proxy.md b/docs/Getting-Started/Reverse-Proxy.md index 09adbc2..98437ea 100644 --- a/docs/Getting-Started/Reverse-Proxy.md +++ b/docs/Getting-Started/Reverse-Proxy.md @@ -1,3 +1,5 @@ + + Here are some basic configurations for popular reverse proxies. Some installations may require modifications to configuration options not listed below. ## Caddy diff --git a/docs/Integrations/Playnite-plugin.md b/docs/Integrations/Playnite-plugin.md index d1163f7..9555dc6 100644 --- a/docs/Integrations/Playnite-plugin.md +++ b/docs/Integrations/Playnite-plugin.md @@ -1,3 +1,6 @@ + + +
romm[playnite] isotipo
diff --git a/docs/Integrations/Tinfoil-integration.md b/docs/Integrations/Tinfoil-integration.md index 0b89b0d..f970bec 100644 --- a/docs/Integrations/Tinfoil-integration.md +++ b/docs/Integrations/Tinfoil-integration.md @@ -1,3 +1,6 @@ + + +
romm[tinfoil] isotipo
diff --git a/docs/Integrations/muOS-app.md b/docs/Integrations/muOS-app.md index 20c6d0c..1d9af2d 100644 --- a/docs/Integrations/muOS-app.md +++ b/docs/Integrations/muOS-app.md @@ -1,3 +1,6 @@ + + +
romm[muos] isotipo
diff --git a/docs/Maintenance/Scheduled-Tasks.md b/docs/Maintenance/Scheduled-Tasks.md index 1dff03e..741589d 100644 --- a/docs/Maintenance/Scheduled-Tasks.md +++ b/docs/Maintenance/Scheduled-Tasks.md @@ -1,3 +1,5 @@ + + ## Scheduled tasks Scheduled tasks can be enabled and configured with the following environment variables: diff --git a/docs/Maintenance/Upgrading-to-3.0.md b/docs/Maintenance/Upgrading-to-3.0.md index 98539da..b5fbc8d 100644 --- a/docs/Maintenance/Upgrading-to-3.0.md +++ b/docs/Maintenance/Upgrading-to-3.0.md @@ -1,3 +1,5 @@ + + Version 3.0 of RomM introduces a number of breaking changes aimed at improving performance and usability, which will require some users to make specific changes before upgrading to ensure compatibility and to take full advantage of the new features. All of the following changes are reflected in the [example docker-compose.yml file](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml), which has been simplified greatly. **Please read this entire file carefully, as failing to do so may cause RomM to become inaccessible or unresponsive.** diff --git a/docs/Miscellaneous/Brand-Guidelines.md b/docs/Miscellaneous/Brand-Guidelines.md index 354564d..c588868 100644 --- a/docs/Miscellaneous/Brand-Guidelines.md +++ b/docs/Miscellaneous/Brand-Guidelines.md @@ -1,3 +1,6 @@ + + + We’ve put together some guidelines for those anyone who wants to use our name and logo. In this context, "RomM", "The RomM Project", "the project", "we", "us", and "our" refer to the RomM project. ## The Logo diff --git a/docs/Miscellaneous/FAQs.md b/docs/Miscellaneous/FAQs.md index b7a9c3b..6bb71f5 100644 --- a/docs/Miscellaneous/FAQs.md +++ b/docs/Miscellaneous/FAQs.md @@ -1,3 +1,5 @@ + + ### When will the next version of RomM be available? When it's ready. diff --git a/docs/OIDC-Guides/OIDC-Setup-With-Zitadel.md b/docs/OIDC-Guides/OIDC-Setup-With-Zitadel.md index f5d9c2d..77c817b 100644 --- a/docs/OIDC-Guides/OIDC-Setup-With-Zitadel.md +++ b/docs/OIDC-Guides/OIDC-Setup-With-Zitadel.md @@ -57,10 +57,8 @@ On the General tab, click the New button under Applications. - `Grant Types`: Authorization Code - `Response Types`: Code - `Authentication Method`: Basic -- `Redirect URIs`: - https://romm.domain.com/api/oauth/openid -- `Post Logout URIs`: - https://romm.domain.com/ +- `Redirect URIs`: `https://romm.domain.com/api/oauth/openid` +- `Post Logout URIs`: `https://romm.domain.com/` Click Create. diff --git a/docs/Platforms-and-Players/Custom-Platforms.md b/docs/Platforms-and-Players/Custom-Platforms.md index 6b07589..56fee89 100644 --- a/docs/Platforms-and-Players/Custom-Platforms.md +++ b/docs/Platforms-and-Players/Custom-Platforms.md @@ -1,3 +1,6 @@ + + + While RomM supports every platform listed in the [Supported Platforms page](../Platforms-and-Players/Supported-Platforms.md), the list is not exhaustive, and you may have ROMs in your library for other platforms. To load those files into RomM, place them in a folder for each platform, and give it a name that's **all lowercase**, with **`-` to separate words**, and with **no white spaces**. For example, `pocket-challenge-v2` would map to `Pocket Challenge V2`, and display the default platform icon in the app. Furthermore, only a portion of the supported platforms have custom icons built-in. If your library has platforms that aren't listed in [the platforms icons list](https://github.com/rommapp/romm/tree/release/frontend/assets/platforms), RomM will display a default fallback icon. diff --git a/docs/Platforms-and-Players/EmulatorJS-Player.md b/docs/Platforms-and-Players/EmulatorJS-Player.md index 96f1450..4d06b22 100644 --- a/docs/Platforms-and-Players/EmulatorJS-Player.md +++ b/docs/Platforms-and-Players/EmulatorJS-Player.md @@ -1,3 +1,5 @@ + + [EmulatorJS](https://emulatorjs.org/) is a web-based emulator for various system; that is, it allows you to run old games in your web browser. It's based on [`RetroArch`](https://www.retroarch.com) compiled with [`Emscripten`](https://emscripten.org/), which is a toolchain for compiling C and C++ code to WebAssembly. diff --git a/docs/Platforms-and-Players/MS-DOS.md b/docs/Platforms-and-Players/MS-DOS.md index 6ba740d..b70f0e8 100644 --- a/docs/Platforms-and-Players/MS-DOS.md +++ b/docs/Platforms-and-Players/MS-DOS.md @@ -1,3 +1,6 @@ + + + [DOS](https://github.com/schellingb/dosbox-pure) is now supported in versions of RomM 4.0 and above thanks to the EmulatorJS player - Simply create a DOS platform to enable the integration diff --git a/docs/Platforms-and-Players/RuffleRS-Player.md b/docs/Platforms-and-Players/RuffleRS-Player.md index c4fd725..6808984 100644 --- a/docs/Platforms-and-Players/RuffleRS-Player.md +++ b/docs/Platforms-and-Players/RuffleRS-Player.md @@ -1,3 +1,5 @@ + + [Ruffle](https://ruffle.rs/) is a web-based player for flash games. With flash now discontinued, this is the best way to play your flash collection in the browser. diff --git a/docs/Platforms-and-Players/Supported-Platforms.md b/docs/Platforms-and-Players/Supported-Platforms.md index b4ba857..4ab34de 100644 --- a/docs/Platforms-and-Players/Supported-Platforms.md +++ b/docs/Platforms-and-Players/Supported-Platforms.md @@ -1,4 +1,6 @@ + + Below is a list of all supported platforms/systems/consoles and their respective folder names. Supported platforms means RomM can fetch metadata from sources for those platforms. diff --git a/docs/System-Setup/Synology-Setup-Guide.md b/docs/System-Setup/Synology-Setup-Guide.md index 756ba4d..d229cae 100644 --- a/docs/System-Setup/Synology-Setup-Guide.md +++ b/docs/System-Setup/Synology-Setup-Guide.md @@ -1,3 +1,5 @@ + + ## Prerequisites This guide assumes you're familiar with Docker and have basic knowledge of server management. You'll need: diff --git a/docs/System-Setup/TrueNAS-Setup-Guide.md b/docs/System-Setup/TrueNAS-Setup-Guide.md index c32a61b..9cdafbe 100644 --- a/docs/System-Setup/TrueNAS-Setup-Guide.md +++ b/docs/System-Setup/TrueNAS-Setup-Guide.md @@ -1,3 +1,5 @@ + + ## Prerequisites This guide assumes you're familiar with Docker and have basic knowledge of TrueNAS. You'll need: diff --git a/docs/System-Setup/Unraid-Setup-Guide.md b/docs/System-Setup/Unraid-Setup-Guide.md index b9823bd..4bbd6d1 100644 --- a/docs/System-Setup/Unraid-Setup-Guide.md +++ b/docs/System-Setup/Unraid-Setup-Guide.md @@ -1,3 +1,5 @@ + + ## Prerequisites Before getting started, install the [Community Apps plugin](https://forums.unraid.net/topic/38582-plug-in-community-applications/) for Unraid. diff --git a/docs/Tools/Igir-Collection-Manager.md b/docs/Tools/Igir-Collection-Manager.md index 7efd35a..58ac15a 100644 --- a/docs/Tools/Igir-Collection-Manager.md +++ b/docs/Tools/Igir-Collection-Manager.md @@ -1,3 +1,5 @@ + + [Igir](https://igir.io/) is a zero-setup ROM collection manager that sorts, filters, extracts or archives, patches, and reports on collections of any size on any OS. It can be used to rename your ROMs to match the RomM database, and to move them into a new directory structure. ## Setup diff --git a/docs/index.md b/docs/index.md index d635fa1..fb5135f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,12 @@ + + + --- + title: Introduction description: An introduction to your beautiful, powerful, self-hosted rom manager -hide: - - toc +hide: - toc + --- RomM logo