{"id":34881997,"url":"https://github.com/open-ev-data/open-ev-data.github.io","last_synced_at":"2026-02-17T21:02:39.954Z","repository":{"id":330847256,"uuid":"1122433549","full_name":"open-ev-data/open-ev-data.github.io","owner":"open-ev-data","description":"Welcome to the repository for the website that holds the documentation of OpenEV Data. This site is built using MkDocs, a static site generator for displaying markdown documentation. If you're looking to make modifications or simply set it up locally, here's what you need to know.","archived":false,"fork":false,"pushed_at":"2025-12-30T01:43:16.000Z","size":24070,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-31T01:30:47.816Z","etag":null,"topics":["github-pages","mike","mkdocs","release","synchronization"],"latest_commit_sha":null,"homepage":"https://open-ev-data.github.io/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-ev-data.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":"docs/governance/CODE_OF_CONDUCT.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-24T18:03:03.000Z","updated_at":"2025-12-30T16:30:01.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/open-ev-data/open-ev-data.github.io","commit_stats":null,"previous_names":["open-ev-data/open-ev-data.github.io"],"tags_count":45,"template":false,"template_full_name":null,"purl":"pkg:github/open-ev-data/open-ev-data.github.io","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ev-data%2Fopen-ev-data.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ev-data%2Fopen-ev-data.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ev-data%2Fopen-ev-data.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ev-data%2Fopen-ev-data.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-ev-data","download_url":"https://codeload.github.com/open-ev-data/open-ev-data.github.io/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ev-data%2Fopen-ev-data.github.io/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29558100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T20:52:40.164Z","status":"ssl_error","status_checked_at":"2026-02-17T20:48:10.325Z","response_time":100,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["github-pages","mike","mkdocs","release","synchronization"],"created_at":"2025-12-26T02:18:32.050Z","updated_at":"2026-02-17T21:02:39.949Z","avatar_url":"https://github.com/open-ev-data.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenEV Data Documentation\n\nWelcome to the repository for the website that holds the documentation of OpenEV Data. This site is built using MkDocs, a static site generator for displaying markdown documentation. If you're looking to make modifications or simply set it up locally, here's what you need to know.\n\n## Prerequisites\n\n* **Python**: 3.13+ is required \u003chttps://www.python.org/\u003e\n* **Poetry**: Used for consistent dependency management \u003chttps://python-poetry.org/\u003e\n\n## Local Setup\n\n1. **Clone the Repository**:\n   ```bash\n   git clone https://github.com/open-ev-data/open-ev-data.github.io.git \u0026\u0026 cd open-ev-data.github.io\n   ```\n\n2. **Install Dependencies**:\n   ```bash\n   poetry install\n   ```\n\n3. **Serve the Website Locally**:\n   ```bash\n   poetry run mkdocs serve\n   ```\n   This will start a local server, and you can access the site at `http://localhost:8000`.\n\n## Making Changes\n\n### Markdown\n\nMkDocs uses Markdown for content. If you're new to Markdown, here's a [quick guide](https://www.markdownguide.org/basic-syntax/).\n\n### Adjusting Site Content\n\nIf you want to add a new page, you can create a new markdown file in the `/docs` directory. To make the page visible in the navigation, add it in the `mkdocs.yml` file under the `nav` section. Take a look at the other markdown files for examples. Ideally add some frontmatter for at least the title to stay consistent.\n\n### Customizing Appearance\n\nWe use the Material for MkDocs theme. In the file `docs/assets/stylesheets/extra.css` you can find all the customizations and add to them. This file basically overrides the default styling.\n\n## Deployment\n\nThis site uses GitHub Actions to publish documentation versions. The deployment is triggered by pushing semantic version tags (e.g., `v1.0.0`).\n\n### Automatic Deployment\n\nWhen you push a tag with `v*.*.*` format:\n\n```bash\ngit tag v1.0.0\ngit push origin v1.0.0\n```\n\nThe pipeline will:\n1. Extract the version (e.g., v1.0.0 → 1.0.x)\n2. Deploy documentation with that version\n3. Update the `latest` alias\n4. Set `latest` as default\n\n### Manual Deployment\n\nYou can also trigger deployment manually from the GitHub Actions tab using the \"workflow_dispatch\" option.\n\n### Versioning\n\nThe project uses [mike](https://github.com/jimporter/mike) for documentation versioning:\n\n- **Patch versions** (v1.0.1, v1.0.2) map to the same minor version (1.0.x)\n- **Minor versions** (v1.1.0, v1.2.0) create new documentation versions (1.1.x, 1.2.x)\n- **Latest** alias always points to the most recent version\n\nExample:\n- `v1.0.0`, `v1.0.1`, `v1.0.2` → All deploy to version `1.0.x`\n- `v1.1.0` → Creates new version `1.1.x`\n- `v2.0.0` → Creates new version `2.0.x`\n\nWhen the pipeline completes, view the documentation at \u003chttps://open-ev-data.github.io\u003e\n\n## About\n\nOpen-source documentation for OpenEV Data - the single source of truth for electric vehicle specifications.\n\n## License\n\nThis documentation is licensed under CC-BY 4.0.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-ev-data%2Fopen-ev-data.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-ev-data%2Fopen-ev-data.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-ev-data%2Fopen-ev-data.github.io/lists"}