📘 Documentation Website for swup
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 ✨
git clone [email protected]:swup/docs.git cd ./docs npm install
This site makes use of Eleventy for compiling the markdown files to HTML. WebPack takes care of bundling and transpiling the assets (SCSS, JavaScript).
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.
npm run build
- https://swup.js.org is hosted on GitHub pages via the deploy workflow
- https://v3.swup.js.org as well as deploy previews for PRs against the default branch are managed via the Netlify account of @hirasso