Skip to content

serenity-rs/serenity-rs.github.io

Repository files navigation

Site source code

The source code for the https://serenity-rs.github.io site.

The site is built using Vite.

Contributing

To contribute, set up a Node.js environment with the PNPM package manager. You may install PNPM using the system package manager, npm install -g pnpm, or corepack enable pnpm.

Install dependencies with pnpm install.

To develop the site, use pnpm run dev to spin up Vite's dev server to test changes locally. The dev server is configured to run on localhost:3000 (or whichever spare port was selected in case 3000 was already taken).

Once you are satisfied with the changes, run pnpm run build to build the site, which will create a minified, bundled version of the site into the dist/ directory. The contents of the dist/ directory can directly be served by a static HTTP server like Nginx, although this site is meant to run on Github pages.

This site uses TypeScript for scripting, and utilises the BEM methodology for CSS.

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

License

Source code of this site is under the ISC license.

About

Site for the organization.

Resources

License

Stars

Watchers

Forks