Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.37 KB

README.md

File metadata and controls

65 lines (41 loc) · 3.37 KB
Raw

HitRuns Wiki

Site URL (Try it Yourself!)

https://hitruns-wiki.vercel.app/

About

Hitman 3 speedrunning wiki. Gameplay tips, Livesplit setup, list of Hitman speedrunning resources, specific strategy tutorials, etc. included.

The site was built with Docusaurus, so reference their documentation for the basics of how this site functions.

More specifically, this site was built on a template from easyops-cn, so go read the original repository's README if you want more information on the technical details of the site / want to make refactoring changes.

The site is deployed on Vercel, although it can also be deployed on any static website host.

Site Features:

HitRuns Wiki has several advantages over the build-in guides on speedrun.com, including:

  • More control over the content (guides are still accessible if speedrun.com is down).
  • More control over the styling (speedrun.com's Markdown version has some strange idiosyncrasies).
  • Website loads faster (not choked full of advertisements as speedrun.com is).
  • Search bar to look up key phrases if you forgot which guide covered what.

Site Setup

Dependencies

You will need either node version 16.15.1 or older, OR yarn version of 3.2.2 or newer. I recommend updating yarn so you can use newer node versions.

How to update yarn:

  • npm install --global yarn
  • yarn set version 3.22

How to change Node version:

Installation

  • yarn install to install required node modules.
  • yarn start to open the dev environment to preview the website.
  • yarn build to build the website locally (needed if you want to test the search function before deployment).
  • For Vercel Deployment: Go to https://vercel.com/VERCEL_USERNAME/PROJECT_NAME/settings and use these settings in "Build and Development" section of Vercel settings.

Contribution Guidelines

If you are a Hitman speedrunner seeking to contribute and have some basic coding knowledge, you should:

  1. Review Basic Markdown Syntax.
  2. Make a Github Account if you don't already have one.
  3. Make a fork.
  4. Go to Docs folder (hitruns-wiki/website/docs) and make your edits. Edit hitruns-wiki/website/sidebars.js as well if you added a new guide.
    • See "Installation" section above for how to run site locally while editing
    • Formatting: Run yarn prettier
  5. Make a Pull request for your changes.

If you don't have much coding knowledge but still want to contribute as a Hitman speedrunner:

  • Edit the Markdown files specified in Step 4 above, and send me the edited files to me on Discord (solderq35).
  • Or just tell me what you want changed on Discord.