{"id":20238786,"url":"https://github.com/openpotato/openplzapi.website","last_synced_at":"2025-08-11T23:06:31.290Z","repository":{"id":171766992,"uuid":"576204322","full_name":"openpotato/openplzapi.website","owner":"openpotato","description":"Website for the OpenPLZ API project","archived":false,"fork":false,"pushed_at":"2025-03-05T20:32:00.000Z","size":332,"stargazers_count":34,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T19:57:55.940Z","etag":null,"topics":["open-data","openplzapi"],"latest_commit_sha":null,"homepage":"https://www.openplzapi.org/en","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openpotato.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2022-12-09T08:57:24.000Z","updated_at":"2025-03-13T15:45:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"cceee882-e778-4ecf-846b-b502210427f7","html_url":"https://github.com/openpotato/openplzapi.website","commit_stats":null,"previous_names":["openpotato/openplzapi.website"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/openpotato/openplzapi.website","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi.website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi.website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi.website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi.website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openpotato","download_url":"https://codeload.github.com/openpotato/openplzapi.website/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi.website/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269970120,"owners_count":24505466,"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","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["open-data","openplzapi"],"created_at":"2024-11-14T08:35:40.484Z","updated_at":"2025-08-11T23:06:31.264Z","avatar_url":"https://github.com/openpotato.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenPLZ API Documentation\n\nThis is the documentation for the OpenPLZ API project. The documentation is Open Source and we have implemented it using [MkDocs](https://www.mkdocs.org) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material). \n\n## Install MkDocs for Windows\n\n1. Install [Python](https://www.python.org). Go to the [Python downloads](https://www.python.org/downloads/) page and download the latest version for Windows. \n\n2. Launch the installer and follow the on-screen instructions.\n\n3. Run the command prompt as Administrator.\n\n4. Enter the command `python --version` and `pip --version` to check the Python installation. In both cases a version number should appear as an output in the command prompt.\n\n5. Enter the command `pip install mkdocs mkdocs-material mkdocs-minify-plugin` to install the *MkDocs* Python package, the *Material for MkDocs* theme and the MkDocs plugin [Minify](https://github.com/byrnereese/mkdocs-minify-plugin).\n\n6. Final test: Enter the command `mkdocs --version`. A version nummer in the command prompt will let you know if everything has been installed correctly.\n\n## Clone Repository\n\nThis repository is a Git repository. To clone the repository to a local commputer you will need a Git client. Either install [Git for Windows](https://gitforwindows.org/) and use the command prompt or install one of the many GUIs. We recommend [GitHub Desktop](https://desktop.github.com) or [SourceTree](https://www.sourcetreeapp.com).\n\n1. Create a local directory for the documentation e.g. `c:\\openplzapi`.\n\n2. Open the command prompt and change to directory `c:\\openplzapi`.\n\n3. Enter the command `git clone https://github.com/openpotato/openplzapi.website.git` to clone the repository.\n\n## Download Repository as Zip Archive\n\nIf you don't want to use Git you can even download the repository as a Zip Archive:\n\n1. Open the URL `https://github.com/openpotato/openplzapi.website` in your web browser\n\n2. Click on the `Clone or download` button then select `Download ZIP`.\n\n3. Extract the Zip Archive to a local folder, e.g. `c:\\openplzapi`.\n\n##  Using MkDocs\n\nYou have installed Python and MkDocs, cloned the repository or downloaded it as a Zip Archive. Now you can generate the documentation locally on your computer.\n\n1. Start the command prompt and change to the directory `c:\\openplzapi\\de` for German documentation or `c:\\openplzapi\\en` for the English documentation.\n\n2. Enter the command `mkdocs build`. The documentation will be regenerated.\n\n3. To display the result, enter the command `mkdocs serve` and open the URL `http://127.0.0.1:8000` in your Web browser.\n\nThe table of contents can be found in the `mkdocs.yml` file and the individual chapters are in the `docs` subdirectory. \n\n## Can I help?\n\nYes, that would be much appreciated. The best way to help is to post a response via the Issue Tracker and/or submit corrections via a Pull Request.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpotato%2Fopenplzapi.website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenpotato%2Fopenplzapi.website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpotato%2Fopenplzapi.website/lists"}