Skip to content

README.md

Latest commit

 

History

History
32 lines (20 loc) · 664 Bytes

README.md

File metadata and controls

32 lines (20 loc) · 664 Bytes

TypeScript Book

This repository contains the source chapters for a TypeScript book aimed at JavaScript developers.

Repository structure

  • Root markdown files are the source material for the book.
  • scripts/build-pages.mjs generates a static site into docs/.
  • docs/ is intended to be published through GitHub Pages.

Build the site

npm run build:pages

To preview the generated site locally:

npm run preview:pages

Then open http://localhost:4173.

GitHub Pages

Set GitHub Pages to deploy from:

  • Branch: main
  • Folder: /docs

After that, every committed rebuild of docs/ will be published as the book site.