{"id":27952046,"url":"https://github.com/swup/docs","last_synced_at":"2025-05-07T16:27:29.538Z","repository":{"id":34865661,"uuid":"185092714","full_name":"swup/docs","owner":"swup","description":"Official swup documentation 📘","archived":false,"fork":false,"pushed_at":"2025-03-08T18:59:52.000Z","size":32617,"stargazers_count":12,"open_issues_count":5,"forks_count":36,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-08T19:32:00.818Z","etag":null,"topics":["animation","docs","documentation","page-transitions","router","swup"],"latest_commit_sha":null,"homepage":"https://swup.js.org/getting-started","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":["gmrchk","daun","hirasso"],"open_collective":"swup"}},"created_at":"2019-05-05T23:13:35.000Z","updated_at":"2025-03-08T18:59:57.000Z","dependencies_parsed_at":"2023-02-12T04:03:25.483Z","dependency_job_id":"32bc5086-6d8e-4fe9-bca7-5cdf9cd5fe67","html_url":"https://github.com/swup/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/swup%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swup%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swup%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swup%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swup","download_url":"https://codeload.github.com/swup/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252914681,"owners_count":21824415,"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":["animation","docs","documentation","page-transitions","router","swup"],"created_at":"2025-05-07T16:27:24.462Z","updated_at":"2025-05-07T16:27:29.523Z","avatar_url":"https://github.com/swup.png","language":"JavaScript","funding_links":["https://github.com/sponsors/gmrchk","https://github.com/sponsors/daun","https://github.com/sponsors/hirasso","https://opencollective.com/swup"],"categories":[],"sub_categories":[],"readme":"# Swup Docs\n\n:blue_book: Documentation Website for [swup](https://swup.js.org/)\n\n## Contributing\n\nSomething to add? Found a typo? Help your future self and others by updating the docs. Simply edit the appropriate markdown files, the docs will be re-generated automatically ✨\n\n## Install locally\n\n```sh\ngit clone git@github.com:swup/docs.git\ncd ./docs\nnpm install\n```\n\n## Develop \u0026 Preview\n\nThis site makes use of [Eleventy](https://github.com/11ty/eleventy) for compiling the markdown files to HTML. [WebPack](https://github.com/webpack/webpack) takes care of bundling and transpiling the assets (SCSS, JavaScript).\n\n```sh\nnpm run watch\n```\n\nThis will start watch modes for both Eleventy and WebPack.\nYour terminal will print the exact `localhost` URL where you can preview your work.\n\n## Build\n\n```sh\nnpm run build\n```\n\n## Deploys\n\n- https://swup.js.org is hosted on GitHub pages via the [deploy workflow](./.github/workflows/deploy.yml)\n- https://v3.swup.js.org as well as deploy previews for PRs against the default branch are managed via the Netlify account of @hirasso\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswup%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswup%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswup%2Fdocs/lists"}