Skip to content

arlandfran/the-beginners-gambit-mdx

Repository files navigation

The Beginner's Gambit

An updated version of an old project originally written in pure HTML and CSS, now rewritten using Next.js, MDX and gchessboard.

Original repo

About

A minimal, documentation style website for the rules of Chess.

Website

Built with

  • Next.js - application framework
  • Tailwindcss / shadcn-ui - styling
  • gchessboard - chessboard web component
  • MDX - content
  • Vercel - deployment

Run Locally

  1. Clone the repo
git clone https://github.com/your-username/the-beginners-gambit.git
  1. Install dependencies
npm install
  1. Build and serve the project
npm run build
npm run start

Credits

  • mganjoo for creating gchessboard and inspiring this rewrite
  • shadcn's open source repo in which I learned a lot about making a documentation site
  • Lichess, Chessfox, Chess.com and Wikipedia as reference for the content