{"id":27362705,"url":"https://github.com/rommapp/docs","last_synced_at":"2025-04-13T03:42:17.020Z","repository":{"id":255436997,"uuid":"849927641","full_name":"rommapp/docs","owner":"rommapp","description":"Docs for the RomM Project","archived":false,"fork":false,"pushed_at":"2025-04-04T02:28:17.000Z","size":9461,"stargazers_count":2,"open_issues_count":1,"forks_count":11,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T06:26:31.463Z","etag":null,"topics":["docs","rommapp"],"latest_commit_sha":null,"homepage":"https://docs.romm.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rommapp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-30T14:30:43.000Z","updated_at":"2025-04-04T02:28:22.000Z","dependencies_parsed_at":"2024-08-31T09:15:26.203Z","dependency_job_id":"e9b9bbc7-cdbf-4e10-84d9-492f157df120","html_url":"https://github.com/rommapp/docs","commit_stats":{"total_commits":38,"total_committers":6,"mean_commits":6.333333333333333,"dds":0.368421052631579,"last_synced_commit":"63002d73a070c066d0ffc08533df46c4749e318d"},"previous_names":["rommapp/wiki","rommapp/docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rommapp%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rommapp%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rommapp%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rommapp%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rommapp","download_url":"https://codeload.github.com/rommapp/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661069,"owners_count":21141390,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","rommapp"],"created_at":"2025-04-13T03:42:16.549Z","updated_at":"2025-04-13T03:42:17.009Z","avatar_url":"https://github.com/rommapp.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n  \u003cimg src=\".github/resources/isotipo.png\" height=\"180px\" width=\"auto\" alt=\"RomM docs logo\"\u003e\n    \u003ch3 style=\"font-size: 25px;\"\u003e\n    Beautiful, powerful, documentation for RomM\n  \u003c/h3\u003e\n\n  \u003cbr /\u003e\n\n[![license-badge-img]][license-badge]\n[![discord-badge-img]][discord-badge]\n\n  \u003c/div\u003e\n\u003c/div\u003e\n\n# Overview\n\nThis is the official documentation for [RomM](https://romm.app/), the beautiful, powerful self-hosted ROM manager and player. Here you'll find everything you need to know about setting up, configuring, and using RomM.\n\n## Building the documentation\n\nWe use `uv` to build the documentation. To install it, run:\n\n```sh\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n```\n\nAnd activate it:\n\n```sh\nuv venv\nsource .venv/bin/activate\n```\n\nThen install python and the required dependencies:\n\n```sh\nuv python install\nuv sync --all-extras --dev\n```\n\nFinally run the following command to serve the documentation from a local server:\n\n```sh\nuv run mkdocs serve [-a ip:port] --livereload\n```\n\n## Contributing\n\nWe welcome all types of contributions, from simple typo fixes to new content. If you'd like to contribute, please read our [code of conduct](CODE_OF_CONDUCT.md).\n\n### Setting up the linter\n\nWe use [Trunk](https://trunk.io) for linting, which combines multiple linters with sensible defaults and a single configuration file. You'll need to install the Trunk CLI to use it.\n\n#### - Install the Trunk CLI\n\n```sh\ncurl https://get.trunk.io -fsSL | bash\n```\n\nAlternative installation methods can be found [here](https://docs.trunk.io/check/usage#install-the-cli). On commit, the linter will run automatically. To run it manually, use the following commands:\n\n```sh\ntrunk fmt\ntrunk check\n```\n\n## Deploy\n\nWe use [mike]() to build and deploy documentation versions. Manually deploy a version needs to update and push the specific version (or a new one if creating a new version) with the following command:\n\n```sh\nuv run mike deploy --push \u003cversion\u003e [alias]\n```\n\nThis will update the `gh-pages` branch and automatically deploys the version with the fix/update to https://docs.romm.app\n\n## Social\n\nJoin us on Discord, where you can ask questions, submit ideas, get help, showcase your collection, and discuss RomM with other users.\n\n[![discord-invite]][discord-invite-url]\n\n\u003c!-- Badges --\u003e\n\n[license-badge-img]: https://img.shields.io/github/license/rommapp/wiki?style=for-the-badge\u0026color=a32d2a\n[license-badge]: LICENSE\n[discord-badge-img]: https://img.shields.io/badge/discord-7289da?style=for-the-badge\n[discord-badge]: https://discord.gg/P5HtHnhUDH\n\n\u003c!-- Links --\u003e\n\n[discord-invite]: https://invidget.switchblade.xyz/P5HtHnhUDH\n[discord-invite-url]: https://discord.gg/P5HtHnhUDH\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frommapp%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frommapp%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frommapp%2Fdocs/lists"}