{"id":13608119,"url":"https://github.com/cucumber/docs","last_synced_at":"2025-04-06T21:12:20.149Z","repository":{"id":37979430,"uuid":"91135423","full_name":"cucumber/docs","owner":"cucumber","description":"Cucumber user documentation","archived":false,"fork":false,"pushed_at":"2024-10-24T08:28:27.000Z","size":14913,"stargazers_count":151,"open_issues_count":41,"forks_count":527,"subscribers_count":80,"default_branch":"main","last_synced_at":"2024-10-29T14:46:53.521Z","etag":null,"topics":["bdd","cucumber","docs","gherkin"],"latest_commit_sha":null,"homepage":"https://cucumber.io/docs/installation/","language":"CSS","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/cucumber.png","metadata":{"funding":{"open_collective":"cucumber","github":"cucumber"},"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}},"created_at":"2017-05-12T22:57:25.000Z","updated_at":"2024-10-22T22:10:54.000Z","dependencies_parsed_at":"2022-07-12T15:20:57.793Z","dependency_job_id":"be367352-2b6b-4600-b171-a66af462c3e0","html_url":"https://github.com/cucumber/docs","commit_stats":{"total_commits":1633,"total_committers":234,"mean_commits":6.978632478632479,"dds":0.8015921616656461,"last_synced_commit":"5c5fe63437dba55026c61c2b6a87cc2a5375a18d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cucumber%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cucumber%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cucumber%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cucumber%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cucumber","download_url":"https://codeload.github.com/cucumber/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247550681,"owners_count":20956987,"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":["bdd","cucumber","docs","gherkin"],"created_at":"2024-08-01T19:01:24.421Z","updated_at":"2025-04-06T21:12:20.116Z","avatar_url":"https://github.com/cucumber.png","language":"CSS","funding_links":["https://opencollective.com/cucumber","https://github.com/sponsors/cucumber"],"categories":["CSS"],"sub_categories":[],"readme":"[![#StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)\n\n# Cucumber Documentation\n\n🚨 This repository is archived. the Cucumber documentation is now at https://github.com/cucumber/website. 🚨\n\n## Contributing Content\n\nFor small edits, the recommended way to contribute is via GitHub.\nEach page in the documentation will have an **Edit** link for this purpose.\n\n## Working locally\n\nFor bigger modifications, the recommended workflow is to edit the documentation\nlocally on your machine, and seeing the results in a web browser.\n\nThis involves getting the source code and building the documentation yourself.\n\n# Get the source code\n\n    git clone https://github.com/cucumber/docs\n    cd docs\n\n### View the site\n\nThe website is built with several tools that are distributed as a Docker image.\n\nInstall [Docker](https://docs.docker.com/install/) if you don't already have\nit on your machine.\n\nBuild and serve the website:\n\n    ./docker_shell.sh\n\nOpen a browser:\n\n    http://localhost:1313\n\nChanges to the contents will be automatically updated in the browser.\n\nTry editing one of the pages under `content` and see for yourself!\n\n### Build the site and check links\n\nWhen you are done editing, build the site and check links:\n\n    ./docker_shell.sh make clean\n    ./docker_shell.sh make\n    ./docker_shell.sh make htmlproofer\n\nBy default, external links are only checked in CI (because it takes a while).\nTo check external links locally:\n\n    CI=true ./docker_shell.sh make htmlproofer\n\nLinks that are broken should be removed or replaced, even if they are only\ntemporarily broken. The reason for this is that broken links negatively affect\nsearch engine rankings.\n\n### Modify theme\n\nSee the [theme README](themes/cucumber-hugo/README.md)\n\n## Architecture\n\nThe site is built with [Hugo](https://gohugo.io), a fast static site generator.\n\nWe have a custom-built theme for the site in `themes/cucumber-hugo`. This theme\nis based on [Bulma](https://bulma.io/) - a lightweight CSS framework.\n\nThe online site is rebuild automatically whenever the git repository receives\nnew commits, either via a `git push`, or by modifying contents in the CMS.\n\nThe [Netlify CMS](https://www.netlifycms.org/) saves contents straight to GitHub\nusing the GitHub API.\n\n## Continuous Deployment\n\nGitHub will notify Netlify for every `git push` thanks to a [webhook](https://github.com/cucumber/docs.cucumber.io/settings/hooks).\n\nNetlify will then build the site and\n[deploy](https://app.netlify.com/sites/cucumber/deploys) it if the build is successful.\n\nThe build will check for broken links and other problems. Internal and external links are checked by [HTMLProofer](https://github.com/gjtorikian/html-proofer).\nOccasionally, the build will fail due to external links being unavailable or giving a timeout. When that happens, please check if these external links are available and if so, 'Retry build' on Netlify.\n\nYou can discuss the documentation in the [Community Discord](https://cucumber.io/community#discord).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcucumber%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcucumber%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcucumber%2Fdocs/lists"}