slide.ng
On this page ▾

Starter

The slide.ng starter is a GitHub template repository. It holds a deck whose slides are a short tutorial, the folders a deck grows into, and the workflows that publish it. Read the deck, then replace it with your own talk.

The deck

Press the right arrow or space to step through it, and o for the overview.

Start a deck

You need Node 22.22.3 or newer.

npx degit slide-ng/starter my-talk
cd my-talk && npm install
npm run dev

npm run dev serves the deck at http://localhost:4230 and reloads when you save slides.md. The other scripts are build (a static site in dist/), export (a PDF, which needs Chromium) and format.

To get a repository of your own on GitHub instead, press Use this template above. To get a smaller deck without the tutorial, run npx @slide-ng/core create my-talk, see Your first deck.

What is in the folder

Path What it is
slides.md The deck: headmatter, then one slide per ---.
components/ Your own Angular components, usable as tags in slides.
snippets/ Code files shown with <<< @/snippets/greeter.ts#greeter.
pages/ Slides in other markdown files, pulled in with src: ./pages/more-slides.md.
public/ Pictures and other files.
.github/ Workflows that publish the deck to GitHub Pages and export a PDF.

Hosting is covered in Hosting, export in Export.