{"id":27998279,"url":"https://github.com/alphagov/govuk-content-api-docs","last_synced_at":"2025-05-08T22:51:56.872Z","repository":{"id":38815598,"uuid":"99561833","full_name":"alphagov/govuk-content-api-docs","owner":"alphagov","description":"Documentation for the GOV.UK Content API.","archived":false,"fork":false,"pushed_at":"2025-05-07T08:46:04.000Z","size":1651,"stargazers_count":4,"open_issues_count":2,"forks_count":7,"subscribers_count":56,"default_branch":"main","last_synced_at":"2025-05-08T22:51:51.890Z","etag":null,"topics":["govuk","tech-docs-template"],"latest_commit_sha":null,"homepage":"https://content-api.publishing.service.gov.uk","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alphagov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2017-08-07T09:37:43.000Z","updated_at":"2025-05-07T08:46:06.000Z","dependencies_parsed_at":"2023-02-14T19:15:32.017Z","dependency_job_id":"9b684f9a-cfdf-4987-bca7-8849ca08d244","html_url":"https://github.com/alphagov/govuk-content-api-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fgovuk-content-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fgovuk-content-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fgovuk-content-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fgovuk-content-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alphagov","download_url":"https://codeload.github.com/alphagov/govuk-content-api-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253160825,"owners_count":21863624,"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","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":["govuk","tech-docs-template"],"created_at":"2025-05-08T22:51:56.182Z","updated_at":"2025-05-08T22:51:56.866Z","avatar_url":"https://github.com/alphagov.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GOV.UK Content API Documentation\n\nThis is a microsite for providing documentation for the GOV.UK Content API. It\nis hosted at https://content-api.publishing.service.gov.uk.\n\nThis documentation is built from source files in this repository and an\n[OpenAPI](https://github.com/OAI/OpenAPI-Specification) specification\n[file][content-store-openapi] for the\n[Content Store][content-store] application.\n\nThe framework for this documentation\nis provided by the [GOV.UK Tech Docs Template][tech-docs-template].\n\n## Updating content\n\nThe [`reference.html`][reference-page] page is built using the\n[`openapi.yaml`][content-store-openapi] file. Changes to content on this page\nshould be made by opening a pull request against the\n[Content Store][content-store] application.\n\nOther HTML pages are in the [`/source`][source-dir] of this repository and are\nauthored using Markdown. You can suggest edits to these pages by making changes\nin a branch or fork of this project and then opening a pull request.\n\n## Running documentation locally\n\nTo run the documentation locally you should have this repository checked out\nas well as the [Content Store][content-store].\n\n### Installing dependencies\n\nSetting up the documentation requires Ruby. Run the following to install the\nnecessary dependencies:\n\n```\nmake requirements\n```\n\n### Preview changes\n\nWhilst writing documentation we can run a middleman server to preview how the\npublished version will look in the browser. After saving a change the preview in\nthe browser will automatically refresh on HTML pages. However for changes to\n[`openapi.yaml`][content-store-openapi] you will need to restart the preview.\n\nThe preview is only available on our own computer. Others won't be able to\naccess it if they are given the link.\n\nType the following to start the server:\n\n```\nmake server\n```\n\nYou should now be able to view a live preview at http://localhost:4567.\n\n## Publishing changes\n\nThe main branch of this repository is published every 30 minutes to the\n`gh-pages` branch. It uses the `deployed-to-production` branch of\n[Content Store][content-store]. Thus once a pull request is merged into main\nchanges will automatically display on the site within 30 minutes.\n\nIf for some reason the automatic deployment fails you can deploy with the\nfollowing command:\n\n```\nmake publish\n```\n\nThis will push to the `gh-pages` branch and therefore deploy to GitHub Pages.\n\n## License\n\n[MIT License](LICENCE)\n\n[content-store-openapi]: https://github.com/alphagov/content-store/blob/main/openapi.yaml\n[content-store]: https://github.com/alphagov/content-store\n\n\n/templates\n[source-dir]: https://github.com/alphagov/govuk-content-api-docs/tree/main/source\n[reference-page]: https://content-api.publishing.service.gov.uk/reference.html\n[tech-docs-template]: https://github.com/alphagov/tech-docs-template\n[rvm]: https://www.ruby-lang.org/en/documentation/installation/#managers\n[bundler]: http://bundler.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Fgovuk-content-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falphagov%2Fgovuk-content-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Fgovuk-content-api-docs/lists"}