{"id":50412698,"url":"https://github.com/jmix-framework/jmix-v3-docs","last_synced_at":"2026-05-31T04:30:42.079Z","repository":{"id":360413059,"uuid":"1249946378","full_name":"jmix-framework/jmix-v3-docs","owner":"jmix-framework","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-26T09:44:02.000Z","size":103117,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"release_3","last_synced_at":"2026-05-26T10:29:51.336Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","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/jmix-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-26T07:01:20.000Z","updated_at":"2026-05-26T08:30:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jmix-framework/jmix-v3-docs","commit_stats":null,"previous_names":["jmix-framework/jmix-v3-docs"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/jmix-framework/jmix-v3-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-v3-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-v3-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-v3-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-v3-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmix-framework","download_url":"https://codeload.github.com/jmix-framework/jmix-v3-docs/tar.gz/refs/heads/release_3","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmix-framework%2Fjmix-v3-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33719601,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-31T02:00:06.040Z","response_time":95,"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":[],"created_at":"2026-05-31T04:30:41.129Z","updated_at":"2026-05-31T04:30:42.074Z","avatar_url":"https://github.com/jmix-framework.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jmix Documentation\n\nThis is the main repository of [Jmix](https://jmix.io) documentation. Guides are located in the repositories of the respective sample projects.  \n\nThe documentation is published at https://docs.jmix.io.\n\n## Development\n\n* Install IntelliJ IDEA and AsciiDoc plugin.\n* Clone the repository and open the root folder in IntelliJ IDEA.\n* Import the Gradle project.\n* Repositories of guides sample projects will be automatically cloned into the `external` folder.\n\nMain documentation modules are located in the `content` folder. Guides are located in the `external/\u003csample\u003e/doc` folders.\n\nThe AsciiDoc IntelliJ plugin correctly recognizes all modules by their `antora.yml` files and allows you to make cross-references.\n\n### Contributing a Jmix Guide\n\nTo add a new guide to the Jmix documentation, follow the steps outlined in [CONTRIBUTING.md](CONTRIBUTING.md). The guide explains how to:\n\n* Set up a new example project based on the Jmix template.\n* Organize your documentation structure with Antora.\n* Submit your guide for review and integration into the Jmix Docs.\n\n## Building\n\n* Install Node LTS release from https://nodejs.org\n\n* Open terminal in `jmix-docs` root folder and run:\n  ```\n  npm i\n  npx antora antora-playbook.yml\n  ```\n\n* Open `jmix-docs/build/site/index.html` in a web browser.\n\nThe `antora-playbook.yml` file allows you to build a single version from the branch checked out locally. To build the entire site from the current state of remote repositories use `antora-playbook.ci.yml` and `--fetch` option:\n\n```\nnpx antora --fetch antora-playbook.ci.yml\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmix-framework%2Fjmix-v3-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmix-framework%2Fjmix-v3-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmix-framework%2Fjmix-v3-docs/lists"}