Skip to content

serenity-rs/serenity-rs.github.io

Repository files navigation

Site source code

This is source code for the https://serenity-rs.github.io site, built using Vite.

Contributing

If you wish to contribute, simply set up a Node.js environment with the NPM package manager.

Once you have Node and NPM, install the necessary dependencies with npm install.

Afterwards, you may use npm run dev to run a dev server to test changes locally, which will run on localhost:3000. Once you are satisfied with the changes, run npm run build to build the site. This will create a minified, bundled version of the site into the docs/ directory, which can directly be served by a HTTP server like Nginx, though, of course, this site is meant to be run on Github Pages.

This site uses TypeScript and SCSS instead of regular JavaScript and CSS. When writing CSS, the BEM methodology is used.

Media files, like images, sounds, and videos, are stored in the public/ directory.

License

Source code of this site is under the ISC license.