{"id":19632988,"url":"https://github.com/sitewhere/sitewhere-documentation","last_synced_at":"2025-11-21T05:04:18.725Z","repository":{"id":21579544,"uuid":"93314803","full_name":"sitewhere/sitewhere-documentation","owner":"sitewhere","description":"Documentation generation for SiteWhere Projects","archived":false,"fork":false,"pushed_at":"2023-01-04T12:46:11.000Z","size":36209,"stargazers_count":19,"open_issues_count":16,"forks_count":48,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-13T23:54:35.944Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sitewhere.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}},"created_at":"2017-06-04T13:20:45.000Z","updated_at":"2023-07-24T04:09:05.000Z","dependencies_parsed_at":"2023-01-12T01:30:21.099Z","dependency_job_id":null,"html_url":"https://github.com/sitewhere/sitewhere-documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sitewhere/sitewhere-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fsitewhere-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fsitewhere-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fsitewhere-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fsitewhere-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sitewhere","download_url":"https://codeload.github.com/sitewhere/sitewhere-documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fsitewhere-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":285560043,"owners_count":27192467,"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-11-21T02:00:06.175Z","response_time":61,"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":"2024-11-11T12:15:56.224Z","updated_at":"2025-11-21T05:04:18.709Z","avatar_url":"https://github.com/sitewhere.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# SiteWhere Community Edition Documentation\r\n\r\nThis repository contains artifacts used to generate documentation for SiteWhere Community Edition.\r\n\r\n## Build\r\n\r\nIn order to build the documentation you need to run the following command:\r\n\r\n```sh\r\nnpm install\r\nnpm run docs:build\r\n```\r\n\r\nTo run it in developer mode, execute the following command:\r\n\r\n```sh\r\nnpm install\r\nnpm run docs:dev\r\n```\r\n\r\nBuild OpenAPI Static Documentation\r\n\r\n```sh\r\ncd docs/.vuepress/public/api2/\r\nwget -O sitewhere-api.json http://localhost:8080/sitewhere/api/v2/api-docs\r\nredoc-cli bundle sitewhere-api.json --options.theme.colors.primary.main=#dc0000 -t sitewhere-docs.hbs\r\nmv redoc-static.html index.html\r\n```\r\n\r\nAccess the documentation at this [url](http://localhost:8080/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsitewhere%2Fsitewhere-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsitewhere%2Fsitewhere-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsitewhere%2Fsitewhere-documentation/lists"}