https://github.com/hamcha/tghandbook

Better client for the /tg/station wiki
https://github.com/hamcha/tghandbook

space-station-13 userscript wiki

Last synced: about 2 months ago
JSON representation

Better client for the /tg/station wiki

• Host: GitHub
• URL: https://github.com/hamcha/tghandbook
• Owner: Hamcha
• License: agpl-3.0
• Created: 2022-05-10T14:41:47.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T08:03:58.000Z (8 months ago)
• Last Synced: 2024-04-22T15:20:23.278Z (8 months ago)
• Topics: space-station-13, userscript, wiki
• Language: TypeScript
• Homepage: https://hamcha.github.io/tghandbook/
• Size: 34.2 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# /tg/station handbook

[![Publish on GitHub Pages](https://github.com/Hamcha/tghandbook/actions/workflows/publish.yml/badge.svg)](https://github.com/Hamcha/tghandbook/actions/workflows/publish.yml) [![Lint](https://github.com/Hamcha/tghandbook/actions/workflows/lint.yml/badge.svg)](https://github.com/Hamcha/tghandbook/actions/workflows/lint.yml)

A fancier way to browse the /tg/ wiki. This handbook is a single page application that bundles 20+ pages from the /tg/station wiki, adds some fancy filtering and Nanotrasen styling.

Try it live here: https://hamcha.github.io/tghandbook/

## What does it do

It adapts the pages layout to be narrow as it's meant to be used in a small window, much like a PDA or an in-game book.

The initial focus was on Chemistry, but the handbook is also good if you need to cross-reference multiple guides at the same time thanks to its fuzzy-search functionality, plus it's gonna get better support for other guides _eventually_.

## I found a problem

Cool! Please open an issue about it [here](https://github.com/Hamcha/tghandbook/issues) or alternatively contact me (@Hamcha, I'm on /tg/station's discord server)

## Development

Start hot-reloading server with `npm start`

Build with `npm run build`

Note: While in development mode some compile-time variables (e.g. the changelog data) will use a locally downloaded version (not up to date) to avoid making requests to GitHub API (as the quota is really low).

## Credits & License

The project is licensed under AGPL-v3.0-only (SPDX identifier). Please see the LICENSE file for details.

This project ships exported pages from the /tg/station wiki in `./data/pages`. Those pages have been written by tons of contributors, check the user list here: https://tgstation13.org/wiki/Special:ListUsers