https://github.com/swup/docs
Official swup documentation 📘
https://github.com/swup/docs
animation docs documentation page-transitions router swup
Last synced: about 1 year ago
JSON representation
Official swup documentation 📘
- Host: GitHub
- URL: https://github.com/swup/docs
- Owner: swup
- Created: 2019-05-05T23:13:35.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-08T18:59:52.000Z (over 1 year ago)
- Last Synced: 2025-03-08T19:32:00.818Z (over 1 year ago)
- Topics: animation, docs, documentation, page-transitions, router, swup
- Language: JavaScript
- Homepage: https://swup.js.org/getting-started
- Size: 31.1 MB
- Stars: 12
- Watchers: 2
- Forks: 36
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Swup Docs
:blue_book: Documentation Website for [swup](https://swup.js.org/)
## Contributing
Something 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 ✨
## Install locally
```sh
git clone git@github.com:swup/docs.git
cd ./docs
npm install
```
## Develop & Preview
This 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).
```sh
npm run watch
```
This will start watch modes for both Eleventy and WebPack.
Your terminal will print the exact `localhost` URL where you can preview your work.
## Build
```sh
npm run build
```
## Deploys
- https://swup.js.org is hosted on GitHub pages via the [deploy workflow](./.github/workflows/deploy.yml)
- https://v3.swup.js.org as well as deploy previews for PRs against the default branch are managed via the Netlify account of @hirasso