The main PCSX2 website is a statically generated website, leveraging Docusaurus.
Setup Scoop as per instructions at https://scoop.sh/.
Open Powershell and install the following.
scoop install git nodejs
npm install --global yarnTo start the server you will need to be in your Github repository that contains the package.json. Use this command to start the server:
yarn start # alternatively, you can use `npm run start`Browse to http://localhost:8080/
You need to install NodeJS using your package manager, here are a few examples:
Ubuntu:
sudo apt-get install nodejsFedora:
sudo dnf install nodejsArch Linux:
sudo pacman -Syu nodejsNow you can install yarn via NPM (Make sure you have installed NodeJS first):
npm install --global yarnTo start the server you will need to be in your Github repository that contains the package.json. Use this command to start the server:
yarn start # alternatively, you can use `npm run start`Browse to http://localhost:8080/
- The docusaurus documentation is very useful and has plenty of examples https://docusaurus.io/docs
- Docusaurus uses React and JSX, seek out related resources for those if editing the frontend code
Run the following to setup the boilerplate for a new article:
yarn new-articleThe article will go into /blog/<year>/<title>
You should add an image to serve as a preview and title card respectively (if appropriate) by using the image: and titleImage: frontmatter field, for example:
---
title: ...
---
image: ./img/my-cool-thumbnail.webp
titleImage: ./img/my-cool-thumbnail.webp
---titleImage assets currently needs to be stored in the static folder.
No image path, whether in the frontMatter or in the article, should contain spaces.
- When running the command above, you should provide an alias that matches the relative URL from the old website. This will prevent legacy links from becoming dead. See existing articles that have been migrated for an example.
