Skip to content

booherbg/game-cheat-sheets

Repository files navigation

Game Cheat Sheets

Markdown cheat sheets for card games, built to HTML. The main index is generated from folder contents and includes an intro block from intro.md (friendly blurb, links to README, GitHub, and the docs). As an extra, the prompts used to create the build system and add content are kept in the repo for educational purposes. My favorite part is actually history.md.

Browse the published site: https://booherbg.github.io/game-cheat-sheets/

Use

npm install

Build one folder (e.g. euchre or docs):

npm run build:euchre
npm run build:docs

Build all folders that contain .md:

npm run build:all

Serve the built HTML for review:

npm run serve

Then open http://localhost:3000. The index lists each folder with .html as an h2; links to its files appear below.

Each .md in a folder becomes a .html with the same base name (e.g. euchre/euchre.mdeuchre/euchre.html). The HTML <title> comes from the first # heading in the file.

Add a new card game

  1. Create a folder (e.g. cribbage/) and add one or more .md files. Each will get its own .html; names need not match the folder (e.g. cribbage/rules.mdcribbage/rules.html).

  2. Start each file with a level‑1 heading for the doc title: # Cribbage Cheat Sheet.

  3. Optionally add a build script in package.json:

    "build:cribbage": "node scripts/build.js cribbage"
  4. Run npm run build:cribbage for that game, or npm run build:all to build every folder that contains .md files.

About

Just a collection of simple game cheat sheets

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors