https://github.com/solderq35/hitruns-wiki
Hitman 3 Speedrunning Wiki
https://github.com/solderq35/hitruns-wiki
documentation docusaurus hitman hitman3
Last synced: 3 months ago
JSON representation
Hitman 3 Speedrunning Wiki
- Host: GitHub
- URL: https://github.com/solderq35/hitruns-wiki
- Owner: solderq35
- License: mit
- Created: 2022-07-08T00:26:35.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-09-27T23:01:03.000Z (9 months ago)
- Last Synced: 2025-09-28T01:04:03.562Z (9 months ago)
- Topics: documentation, docusaurus, hitman, hitman3
- Language: TypeScript
- Homepage: https://hitruns-wiki.vercel.app
- Size: 4.29 MB
- Stars: 1
- Watchers: 2
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docusaurus.io/docs), so reference their documentation for the basics of how this site functions.
More specifically, this site was built on a template from [easyops-cn](https://github.com/easyops-cn), so go read [the original repository's README](https://github.com/easyops-cn/docusaurus-search-local/blob/master/README.md) if you want more information on the technical details of the site / want to make refactoring changes.
The site is deployed on [Vercel](https://vercel.com/docs), 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
Currently using Node v22.20.0 for Vercel deployment.
How to update yarn:
- `npm install --global yarn`
- `yarn set version 3.22`
How to change Node version:
- See https://github.com/coreybutler/nvm-windows or https://github.com/nvm-sh/nvm
### 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](https://i.ibb.co/711Y9bS/vercel-build-settings.png) 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](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
2. Make a Github Account if you don't already have one.
3. [Make a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
4. Go to [Docs folder](https://github.com/solderq35/hitruns-wiki/tree/master/website/docs) (`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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-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.