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/
npm installBuild one folder (e.g. euchre or docs):
npm run build:euchre
npm run build:docsBuild all folders that contain .md:
npm run build:allServe the built HTML for review:
npm run serveThen 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.md → euchre/euchre.html). The HTML <title> comes from the first # heading in the file.
-
Create a folder (e.g.
cribbage/) and add one or more.mdfiles. Each will get its own.html; names need not match the folder (e.g.cribbage/rules.md→cribbage/rules.html). -
Start each file with a level‑1 heading for the doc title:
# Cribbage Cheat Sheet. -
Optionally add a build script in
package.json:"build:cribbage": "node scripts/build.js cribbage"
-
Run
npm run build:cribbagefor that game, ornpm run build:allto build every folder that contains.mdfiles.