Skip to content

A template for combining Astro and Reveal.js to build and deploy beautiful presentation websites.

Notifications You must be signed in to change notification settings

databio/astro-reveal

Repository files navigation

Astro + Reveal.js

A template for creating portable, composable presentations with Markdown.

Features

  • Portable: Each presentation in its own folder with co-located images
  • Composable: Combine presentations using frontmatter includes
  • Reusable: Create slide modules with template variables ({{title}}, {{author}})
  • Automatic image rebasing: Relative paths work everywhere

Quick Start

npm install
npm run dev

Visit http://localhost:4321 to see examples and documentation.

Adding Presentations

Standalone Presentation

/public/slides/my-talk/
  ├── my-talk.md
  └── image.png
---
title: "My Talk"
author: "Your Name"
---

## Slide 1
![Image](image.png)

Using Slide Modules

---
title: "Conference Talk"
author: "Your Name"
includes: ["title", "my-talk", "acknowledgments"]
---

Modules are in /public/slides/_modules/. Use {{variable}} syntax for dynamic content.

Commands

Command Action
npm install Install dependencies
npm run dev Start dev server at localhost:4321
npm run build Build for production

Documentation

About

A template for combining Astro and Reveal.js to build and deploy beautiful presentation websites.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published