{"id":22281233,"url":"https://github.com/alphagov/tech-docs-gem","last_synced_at":"2025-04-12T22:31:46.374Z","repository":{"id":30110570,"uuid":"123826920","full_name":"alphagov/tech-docs-gem","owner":"alphagov","description":"Gem to distribute the tech docs project","archived":false,"fork":false,"pushed_at":"2024-10-23T15:39:42.000Z","size":3709,"stargazers_count":15,"open_issues_count":41,"forks_count":38,"subscribers_count":85,"default_branch":"main","last_synced_at":"2024-10-25T06:19:08.330Z","etag":null,"topics":["cross-gds","tech-docs-template","tech-writers"],"latest_commit_sha":null,"homepage":"https://tdt-documentation.london.cloudapps.digital/","language":"JavaScript","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":"CHANGELOG.md","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":"2018-03-04T20:39:02.000Z","updated_at":"2024-10-23T15:38:55.000Z","dependencies_parsed_at":"2024-04-23T16:39:45.476Z","dependency_job_id":"0e409596-3b70-4830-9709-c01205d4e7a0","html_url":"https://github.com/alphagov/tech-docs-gem","commit_stats":{"total_commits":744,"total_committers":57,"mean_commits":"13.052631578947368","dds":0.8077956989247312,"last_synced_commit":"7c293966eaa3a49c5390f98a5e7f57c136e7faaa"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Ftech-docs-gem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Ftech-docs-gem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Ftech-docs-gem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Ftech-docs-gem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alphagov","download_url":"https://codeload.github.com/alphagov/tech-docs-gem/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248640401,"owners_count":21138034,"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":["cross-gds","tech-docs-template","tech-writers"],"created_at":"2024-12-03T16:16:23.778Z","updated_at":"2025-04-12T22:31:46.353Z","avatar_url":"https://github.com/alphagov.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tech Docs Template - gem\n\nThis repo contains the Ruby gem that distributes the [Tech Docs Template][tdt-template]. The Tech Docs Template is a [middleman template][mmt] that\nyou can use to build technical documentation using a GOV.UK style.\n\nTo find out more about setting up and managing content for a website using this template, see the [Tech Docs Template documentation][tdt-docs].\n\n## Contributing\n\nEverybody who uses this project is encouraged to contribute.\n\nFind out how to [contribute](https://tdt-documentation.london.cloudapps.digital/support/#contribute).\n\n## GOV.UK frontend\n\nThis gem uses [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend), part of the [GOV.UK Design System](https://design-system.service.gov.uk/).\n\nWe use `npm` to download the govuk-frontend package. To update to a new version, change the version in the [package.json file](package.json) and run `npm update`.\n\n## Developing locally\n\nThere are 2 ways to develop with this gem. You can see your changes on either:\n\n- your own Tech Docs Template website\n- the example in this repository\n\n### Use your own Tech Docs Template website\n\nTo see how your changes to the gem affect your website, point your website's Gemfile to your local checkout:\n\n```rb\ngem 'govuk_tech_docs', path: '../tech-docs-gem'\n```\n\nTo preview your documentation changes locally, see the [Tech Docs Template documentation on previewing your documentation](https://tdt-documentation.london.cloudapps.digital/create_project/preview/#preview-your-documentation).\n\nIf you experience [the FFI gem issue for Mojave users](https://github.com/alphagov/tech-docs-gem/issues/254), you should refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).\n\n### Use the example in this repo\n\nTo start the example in this repo, run:\n\n```sh\ncd example\nbundle install\nbundle exec middleman server\n```\n\nSee your website on `http://localhost:4567` in your browser.\n\nIf you experience [the FFI gem issue for Mojave users](https://github.com/alphagov/tech-docs-gem/issues/254), you should refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).\n\nFor more information on previewing your documentation locally, see the [Tech Docs template documentation on previewing your documentation](https://tdt-documentation.london.cloudapps.digital/create_project/preview/#preview-your-documentation).\n\n## Tests\n\nThis repository contains automated JavaScript tests that use the [Jasmine test framework][jas].\n\nYou can run these tests and see the results in your browser.\n\n1. Run `bundle exec rake jasmine`.\n2. Go to `http://localhost:8888` in your browser.\n\nTo run the tests and see the results in your terminal, run:\n\n```\nbundle exec rake jasmine:ci\n```\n\n## Issue with FFI on OSX Mojave\n\nUsers on OSX Mojave (10.14) may get this error when running `bundle exec middleman serve` on apps that use this gem.\n\nThere are 3 possible ways to solve this. From best to worst, you can:\n\n* upgrade to macOS 10.15 (Catalina) or higher\n* tell rubygems not to use the system ffi by running `gem install ffi -- --disable-system-libffi` in the command line when the error shows\n* pin the ffi version back to 1.12.2 by editing the Gemfile of your app\n\n## Releasing new versions\n\nTo release a new version, create a new pull request (PR) that updates [version.rb](lib/govuk_tech_docs/version.rb) and [CHANGELOG.md](CHANGELOG.md).\n\nDo not include other changes in your pull request, as this makes it easier to find out what was released when. See an example of a [PR for releasing a new version](https://github.com/alphagov/tech-docs-gem/pull/15).\n\nTravis will automatically release a [new version to Rubygems.org](https://rubygems.org/gems/govuk_tech_docs).\n\n## Licence\n\nUnless stated otherwise, the codebase is released under [the MIT License][mit]. This covers both the codebase and any sample code in the documentation.\n\nThe documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl] licence.\n\n[mit]: LICENCE\n[copyright]: http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/\n[ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/\n[tdt-docs]: https://tdt-documentation.london.cloudapps.digital\n[tdt-template]: https://github.com/alphagov/tech-docs-template\n[tdt-readme]: https://github.com/alphagov/tech-docs-template/blob/main/README.md\n[mmt]: https://middlemanapp.com/advanced/project_templates/\n\n[jas]: https://jasmine.github.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Ftech-docs-gem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falphagov%2Ftech-docs-gem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Ftech-docs-gem/lists"}