https://github.com/ewanlyon/speedrun-docs
Template for Speedrun Documentation
https://github.com/ewanlyon/speedrun-docs
documentation docusaurus speedrun speedrun-tool speedrunning
Last synced: 6 months ago
JSON representation
Template for Speedrun Documentation
- Host: GitHub
- URL: https://github.com/ewanlyon/speedrun-docs
- Owner: EwanLyon
- Created: 2023-08-06T06:12:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T12:06:25.000Z (about 1 year ago)
- Last Synced: 2025-02-06T15:52:43.139Z (8 months ago)
- Topics: documentation, docusaurus, speedrun, speedrun-tool, speedrunning
- Language: TypeScript
- Homepage: https://ewanlyon.github.io/speedrun-docs/
- Size: 4.76 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Speedrun Docs
This template is built using [Docusaurus 3](https://docusaurus.io/). You can find a hosted version of this template at [ewanlyon.github.io/speedrun-docs/](https://ewanlyon.github.io/speedrun-docs/)
## Showcase
- [Heavenly Bodies](https://ewanlyon.github.io/HeavenlyBodies-SpeedrunDocs/)
## Installation
```cmd
npm install
```
## Local Development
```cmd
npm run start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Build
```cmd
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.