{"id":48819340,"url":"https://github.com/vaadin/docs","last_synced_at":"2026-04-14T14:01:56.342Z","repository":{"id":36957703,"uuid":"235099557","full_name":"vaadin/docs","owner":"vaadin","description":"Official documentation for Vaadin and Hilla.","archived":false,"fork":false,"pushed_at":"2026-04-10T11:04:36.000Z","size":631256,"stargazers_count":37,"open_issues_count":336,"forks_count":216,"subscribers_count":17,"default_branch":"main","last_synced_at":"2026-04-10T11:25:59.740Z","etag":null,"topics":["documentation","hilla","vaadin"],"latest_commit_sha":null,"homepage":"https://vaadin.com/docs","language":"AsciiDoc","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/vaadin.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-01-20T12:45:56.000Z","updated_at":"2026-04-09T08:50:04.000Z","dependencies_parsed_at":"2023-10-14T22:53:23.175Z","dependency_job_id":"d8401e2b-5558-4a66-a8dc-faf75b7f180a","html_url":"https://github.com/vaadin/docs","commit_stats":null,"previous_names":[],"tags_count":339,"template":false,"template_full_name":null,"purl":"pkg:github/vaadin/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaadin%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaadin%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaadin%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaadin%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vaadin","download_url":"https://codeload.github.com/vaadin/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaadin%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31799411,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T11:13:53.975Z","status":"ssl_error","status_checked_at":"2026-04-14T11:13:53.299Z","response_time":153,"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":["documentation","hilla","vaadin"],"created_at":"2026-04-14T14:01:48.376Z","updated_at":"2026-04-14T14:01:56.311Z","avatar_url":"https://github.com/vaadin.png","language":"AsciiDoc","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vaadin documentation\n\nOfficial documentation and code examples for Vaadin.\n\nThis repository does not generate the [vaadin.com/docs](https://vaadin.com/docs) website. It only contains the content for them. The builds are done using [Vaadin Design System Publisher](https://vaadin.com/design-system-publisher).\n\nIf you have a Vaadin subscription that includes a license to use Design System Publisher, you can run the local development build with the following command:\n\n```sh\nnpm run dspublisher:start\n```\n\n## Contents\n\nFiles not explicitly listed below are from the standard Vaadin project setup.\n\n### `articles`\n\nA hierarchy of AsciiDoc files (`.adoc`), documenting the use of all Vaadin features. The file path defines the resulting URL on the documentation site.\n\nFor example:\n\n- `articles/flow/index.adoc` → `/flow/`\n- `articles/flow/forms/data-binding.adoc` → `/flow/forms/data-binding/`\n\nSee the [contribution guides](https://vaadin.com/docs/contributing/docs) to learn more.\n\n### `frontend`\n\nTypeScript examples, which are included as rendered examples in the documentation. Follow Vaadin best practices when creating code examples.\n\n### `src`\n\nFlow/Java examples, which are included as rendered examples in the documentation. Follow Vaadin best practices when creating code examples.\n\n### `scripts`\n\nProject-related scripts (tests, validation builds, preview deployment, etc).\n\n### `.github`\n\nFiles related to linting the articles against the writing style guidelines with [Vale](https://docs.errata.ai/vale/about). See [Vale linter setup instructions](https://vaadin.com/docs/latest/contributing-docs/authoring/editing-tools/#vale).\n\n### `versions.json`\n\nDescribes the publicly available documentation versions. These versions will appear in the published website, as options for the users. This file is only relevant in the `latest` branch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaadin%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvaadin%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaadin%2Fdocs/lists"}