{"id":13572135,"url":"https://github.com/missionpinball/mpf-docs","last_synced_at":"2026-02-15T10:43:50.502Z","repository":{"id":6092562,"uuid":"54759041","full_name":"missionpinball/mpf-docs","owner":"missionpinball","description":"missionpinball.org website content \u0026 all MPF docs","archived":false,"fork":false,"pushed_at":"2024-05-21T19:35:36.000Z","size":70874,"stargazers_count":29,"open_issues_count":23,"forks_count":109,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-05-22T00:52:27.059Z","etag":null,"topics":["documentation","mission-pinball-framework","mpf","pinball"],"latest_commit_sha":null,"homepage":"https://missionpinball.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/missionpinball.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"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":"2016-03-26T02:39:50.000Z","updated_at":"2024-05-30T00:52:13.288Z","dependencies_parsed_at":"2023-09-22T06:24:42.164Z","dependency_job_id":"333fa79e-4205-4bd3-b313-44f86b68c276","html_url":"https://github.com/missionpinball/mpf-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/missionpinball%2Fmpf-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/missionpinball%2Fmpf-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/missionpinball%2Fmpf-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/missionpinball%2Fmpf-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/missionpinball","download_url":"https://codeload.github.com/missionpinball/mpf-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247153591,"owners_count":20892696,"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":["documentation","mission-pinball-framework","mpf","pinball"],"created_at":"2024-08-01T14:01:14.452Z","updated_at":"2026-02-15T10:43:50.497Z","avatar_url":"https://github.com/missionpinball.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Mission Pinball website \u0026 documentation\n\nThis repo contains all the source code for [MissionPinball.org](https://missionpinball.org), which also includes all user documentation.\n\n## Technical details\n\nThe MPF website is built using [MkDocs](http://www.mkdocs.org/), a static\nsite generator using Markdown files as the source. It uses the\n[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.\n\nThe site is hosted on GitHub Pages, and the `main` branch of this repo controls\nwhat's published to the live site. A [GitHub workflow](https://github.com/missionpinball/mpf-docs/blob/main/.github/workflows/deploy.yml) is used to automatically\nbuild and deploy the site whenever a commit or merge is made to the `main` branch.\nYou can see the commits and page builds in the [Actions tab](https://github.com/missionpinball/mpf-docs/actions).\n\n## To build / run locally\n\n1. Clone the repo\n2. Open a terminal window and `cd` into the root folder of this repo\n3. `pip install -r requirements.txt` (to install mkdocs and what it needs)\n4. `mkdocs serve` (runs a local web server on port 8000)\n\nYou should be able to access the doc site via your web browser at `localhost:8000`.\n\n## To contribute\n\nWe would love contributions to the docs! We have a Contributing Guide ([view on GitHub](https://github.com/missionpinball/mpf-docs/blob/main/docs/about/help_docs.md) | [view on the website](https://missionpinball.org/latest/about/help_docs/))\nwhich explains how to contribute.\n\n## Configuring site navigation\n\nAll the navigation for the site is configured in the `mkdocs.yml` file. This\nis somewhat annoying since it means that if you add a new page, you have to\ngo to a completely separate place to set up the nav.\n\nI tried to use the auto pages plugin to automatically\ncreate the navigation, and/or at least keep it local to each subfolder, but\nunfortunately our navigation tree is different from our folder hierarchy which\nmade that not possible. We may be able to combine both methods, and this is\nsomething someone could look into.\n\n## Script to build the showcase pages\n\nThe MPF project showcase is published at [missionpinball.org/latest/showcase](https://missionpinball.org/latest/showcase/).\nThe source content for each showcase entry are YAML files [`/showcase`](https://github.com/missionpinball/mpf-docs/tree/main/showcase) folder of this repo. The script [`generate_showcase_pages.py`](https://github.com/missionpinball/mpf-docs/blob/main/build_tools/generate_showcase_pages.py) generates the .md files for each project, and also generates the showcase index\npage.\n\nThis script is run automatically as part of the GitHub Actions workflow.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmissionpinball%2Fmpf-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmissionpinball%2Fmpf-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmissionpinball%2Fmpf-docs/lists"}