This is the website for the Torrust project, containing information about the project, and in the future, some guides and tutorials.
It was built with a few goals in mind:
- Responsive design: the website looks and behaves well on screens of all sizes;
- Fast: it only loads what's needed for it to work;
- Privacy-friendly: it doesn't track you, and doesn't load any external resources;
To run it locally, you simply have to run:
# First, install dependencies
npm install
# Then, run it on dev mode
npm run devThe site should now be available at http://localhost:5173/ on your local machine, and your local machine's IP address on your network—great for testing on mobile OSes.
This website uses Histoire, a Vite-based Storybook alternative to be able to see and develop components in isolation. To open it, run npm run story:dev.
This website uses image transmutation to automatically optimize images used in the site. This means that even if you use non-optimal image formats (like lossless PNGs), it will go over the images and convert images to WebP and AVIF for you, as long as you use the <Image /> component instead of <img />. This is done on build, so it doesn't change anything when running the website locally.
All posts live in src/routes/blog/ and are processed with MDsveX. For step-by-step instructions on creating a new blog post, see .github/skills/add-blog-post/SKILL.md.
To make it easier to manage posts, the Front Matter VS Code extension gives you a nice CMS-like UI.
When you run npm run build, the website will be compiled into a static site, which means you can host it pretty much anywhere.
You can deploy it manually to GitHub Pages by running npm run build && npm run deploy.