{"id":25426746,"url":"https://github.com/plateformeio/docs","last_synced_at":"2026-04-11T19:34:06.988Z","repository":{"id":277588873,"uuid":"932786432","full_name":"plateformeio/docs","owner":"plateformeio","description":"The official documentation of the Plateforme framework","archived":false,"fork":false,"pushed_at":"2025-02-26T18:55:03.000Z","size":2624,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-01T23:35:25.789Z","etag":null,"topics":["api","app","asgi","async","data","db","docs","fastapi","plateforme","pydantic","python","restx","services","sqlalchemy"],"latest_commit_sha":null,"homepage":"https://docs.plateforme.io","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/plateformeio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null},"funding":{"github":"plateformeio"}},"created_at":"2025-02-14T14:18:09.000Z","updated_at":"2025-02-26T18:55:07.000Z","dependencies_parsed_at":"2025-02-14T19:32:05.948Z","dependency_job_id":"b7115719-74f6-45a5-9071-6f1ebac7bcc5","html_url":"https://github.com/plateformeio/docs","commit_stats":null,"previous_names":["plateformeio/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/plateformeio/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plateformeio%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plateformeio%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plateformeio%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plateformeio%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plateformeio","download_url":"https://codeload.github.com/plateformeio/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plateformeio%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31693272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T13:07:20.380Z","status":"ssl_error","status_checked_at":"2026-04-11T13:06:47.903Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["api","app","asgi","async","data","db","docs","fastapi","plateforme","pydantic","python","restx","services","sqlalchemy"],"created_at":"2025-02-17T00:21:39.875Z","updated_at":"2026-04-11T19:34:06.938Z","avatar_url":"https://github.com/plateformeio.png","language":"CSS","funding_links":["https://github.com/sponsors/plateformeio"],"categories":[],"sub_categories":[],"readme":"# Plateforme Docs\n\n[![License: CC BY-NC 4.0](https://img.shields.io/badge/License-CC_BY--NC_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc/4.0/)\n\nThe official documentation for the Plateforme framework.\n\n## Installation\n\nInstall the required dependencies using the following command:\n\n```bash\nhatch run true\n```\n\n### Development\n\nOptionally, a custom path to the source code of the `plateforme` framework used for the documentation can be set in the development environment. You can set it using the following command:\n\n```bash\nexport PLATEFORME=\"file:///path/to/plateforme\"\n```\n\nTo install the required dependencies for development, use the following command:\n\n```bash\nhatch -v run dev:true\n```\n\n#### Environment Matrix\n\nThe development environment supports different modes that determine documentation features and reference sources. Here's a breakdown of the available options:\n\n| Mode | Description | Dependencies | Environment variables |\n| ---- | ----------- | ------------ | --------------------- |\n| `minimal` | Basic documentation without API reference and packages | - | - |\n| `with-pkg` | Documentation with package references | - | `PACKAGES_PATH=..` |\n| `with-pkg-local` | Documentation with local package references | `plateforme @ {env}` | `PLATEFORME=file:///path/to/plateforme`\u003cbr\u003e`PACKAGES_PATH=..` |\n| `with-ref` | Documentation with API reference from PyPI | `docs[reference]` | `PLUGINS_MKDOCSTRINGS=TRUE` |\n| `with-ref-local` | Documentation with API reference from local install | `docs[reference]`\u003cbr\u003e`plateforme @ {env}` | `PLATEFORME=file:///path/to/plateforme`\u003cbr\u003e`PLUGINS_MKDOCSTRINGS=TRUE` |\n| `prelaunch` | Complete documentation with API reference from PyPI | `docs[reference]` | `PACKAGES_PATH=..`\u003cbr\u003e`PLUGINS_MKDOCSTRINGS=TRUE` |\n| `prelaunch-local` | Complete documentation with API reference from local install | `docs[reference]`\u003cbr\u003e`plateforme @ {env}` | `PLATEFORME=file:///path/to/plateforme`\u003cbr\u003e`PACKAGES_PATH=..`\u003cbr\u003e`PLUGINS_MKDOCSTRINGS=TRUE` |\n\nThese modes can be used with any Hatch command using the following syntax:\n\n```bash\nhatch [options] run dev.[mode]:[command]\n```\n\nFor example:\n\n```bash\n# Serve standard documentation\nhatch -v run dev.minimal:serve\n\n# Serve standard documentation with packages using local source\nhatch -v run dev.with-pkg-local:serve\n\n# Serve complete documentation using PyPI source\nhatch -v run dev.prelaunch:serve\n```\n\n### Production\n\nTo install the required dependencies for production, use the following command:\n\n```bash\nhatch -v run prod:true\n```\n\n## Usage\n\n### Building the documentation\n\n```bash\nhatch [options] run [env]:build\n```\n\n### Deploying the documentation\n\n```bash\nhatch [options] run [env]:deploy {args}\n```\n\n\u003e See [versioning](#versioning) for more details.\n\n### Serving the documentation\n\nStart the live-reloading docs server by running either one of the following commands:\n\n```bash\n# Test the current documentation locally without versioning\nhatch [options] run [env]:serve\n\n# Test the documentation with version selector\nhatch [options] run [env]:serve-versions\n```\n\n\u003e The `serve` command uses `mkdocs` to serve the documentation, while the `serve-versions` command uses `mike` to serve the documentation with version selector.\n\n## Project layout\n\n    mkdocs.yml      # The configuration file.\n    docs/\n        index.md    # The documentation homepage.\n        ...         # Other documentation markdown pages.\n    overrides/\n        .icons/     # Icons for the documentation.\n        assets/     # Images, logo, styles and other files.\n        partials/   # Custom templates and partials.\n        index.html  # Home page.\n        main.html   # Main page.\n        ...         # Other html pages.\n    src/\n        ...         # Code snippets and examples.\n    tests/\n        ...         # Test files for the code snippets.\n\n## Versioning\n\nThe documentation is versioned using [`mike`](https://github.com/jimporter/mike) dependency.\n\n### Publishing a version\n\nTo deploy a new version, run the following command:\n\n```bash\nhatch [options] run [env]:deploy --update-aliases [identifier] [alias]\n```\n\nIn addition, you can specify where to deploy your docs via `-b/--branch`, `-r/--remote`, and `--deploy-prefix`, specifying the branch, remote, and directory prefix within the branch, respectively. To push your docs to a remote branch, simply add `-p/--push` to your command.\n\nTo set the default version that appears at the root URL:\n\n```bash\nhatch -v run prod:mike set-default latest\n```\n\nAll modifications can be committed and pushed to the remote repository. By default, the `gh-pages` branch is used.\n\n```bash\ngit push origin [branch]\n```\n\n### Managing versions\n\nVersions can be listed, deleted, and aliased using the following commands:\n\n```bash\n# List all versions\nmike list\n\n# Delete all or a specific version\nmike delete --all\nmike delete [identifier]\n\n# Alias a version\nmike alias [identifier] [alias]\n\n# Set the default version\nmike set-default [alias]\n```\n\n### Common options\n\n| Option | Description |\n| ------ | ----------- |\n| `--push`, `-p` | Push changes immediately to remote |\n| `--update-aliases`, `-u` | Allow updating existing aliases |\n| `--branch`, `-b` | Specify target branch (default: gh-pages) |\n| `--remote`, `-r` | Specify git remote (default: origin) |\n\n## See also\n\nMkDocs and Material for MkDocs documentation:\n- [MkDocs](https://www.mkdocs.org)\n- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplateformeio%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplateformeio%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplateformeio%2Fdocs/lists"}