mirrors/paceboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
paceboard is a template-based static site generator for speedrun leaderboards.
36 commits 2 branches 1 tag 253 KiB
Python 78.1%
HTML 15.3%
CSS 6.6%
Find a file
Zachary Talis 863a33c2cd Replace dictionary with list
2021-06-28 18:40:04 -04:00
assets Initial style, formatting tweaks 2021-06-23 11:47:42 -04:00
categories Documentation pass 2021-06-27 23:57:53 -04:00
css Implement category leaderboards 2021-06-25 23:05:19 -04:00
csv Remove tk_category_description 2021-06-25 23:22:33 -04:00
runs Documentation pass 2021-06-27 23:57:53 -04:00
scripts Replace dictionary with list 2021-06-28 18:40:04 -04:00
templates Documentation pass 2021-06-27 23:57:53 -04:00
LICENSE Update license 2021-06-28 00:10:08 -04:00
paceboard.py Add method docs and comments 2021-06-27 22:40:15 -04:00
README.md Documentation pass 2021-06-27 23:57:53 -04:00

README.md

paceboard

Project logo, a sine wave forming gravestones in the negative space.

Blog post - Example site

About

paceboard is a template-based static site generator for speedrun leaderboards.

You can configure site details, implement categories, and add runs all from a single Python script (paceboard.py).

Category and run information is stored in csv files for ease of access and editing.

Instructions

This guide assumes that you know the basics of hosting your own website. Since paceboard is a static site generator, you can host via the free GitHub Pages, assuming you know how to use Git.

Let's get started!

  1. Make sure you have the latest version of Python 3.
  2. Download or fork the paceboard repository.
  3. Go to your install location via the command line, then run python3 paceboard.py. Follow the prompts to configure and auto-generate your site!
  4. Discover you made a typo? Hop into the csv folder and you can manually edit the spreadsheets inside. Afterwards, running python3 scripts/generate.py will update your site with the new info.

Template-based?

Within the templates folder are the HTML files paceboard uses to format the site. If you're feeling intrepid, you can edit these templates to your liking.

During page generation, paceboard swaps out the tk_ and lk_ strings with their corresponding values in the database.