Sitekick Remastered Website

Welcome to the repository for Sitekick Remastered's website!

This website is made using Docusaurus.

Software Needed

1. Git
2. Node 22.13.0 or later
3. VSCode (Recommended)

Setting up your environment

1. Clone https://github.com/SitekickRemastered/Web.git
2. Navigate into the /Web/ directory
3. Run npm i to install dependencies
4. Use npm start to start the site
   • The site should run locally on http://localhost:3000/

Note: An .env file is required for some pages. example.env is an example of what that file should look like and how it works.

Note for Wiki Editors

If you're editing the wiki, the only folder you need is /docs/.

Each folder within /docs/ will generate a category for the wiki, and inside you should have a _category_.json file. _category_.json only needs the following:

{
  "label": "Chipendium", // The text that will appear on the sidebar of the wiki
  "position": 3          // The position in the sidebar the category will have
}

More metadata for _category_.json can be found on the Docusaurus Docs page about category item metadata

From there, you can create pages through an .mdx file.

.mdx is essentially markdown with a few more added features; specifically the ability to write JSX within the markdown files and render React components. You don't need JSX to create pages, but if you choose to create some components, please put them into /src/components/Wiki/.

You can read more about .mdx files on the Docusaurus docs.

Note for archiving images

We use a CDN to store / archive very large images. This way, the build doesn't take as long and the website is updated faster. If you have files for our archive, please contact someone on the team so we can upload them.