https://github.com/fabe/gatsby-starter-deck

🗣 Create presentations using Gatsby, React & Markdown.
https://github.com/fabe/gatsby-starter-deck

gatsby gatsby-starter gatsbyjs markdown presentations react slides slideshow

Last synced: about 1 month ago
JSON representation

🗣 Create presentations using Gatsby, React & Markdown.

• Host: GitHub
• URL: https://github.com/fabe/gatsby-starter-deck
• Owner: fabe
• License: mit
• Archived: true
• Created: 2017-11-23T23:22:27.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-06-16T16:27:47.000Z (over 4 years ago)
• Last Synced: 2024-09-23T15:04:02.822Z (about 2 months ago)
• Topics: gatsby, gatsby-starter, gatsbyjs, markdown, presentations, react, slides, slideshow
• Language: JavaScript
• Homepage: https://gatsby-deck.netlify.com
• Size: 579 KB
• Stars: 519
• Watchers: 6
• Forks: 78
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> 🚨 This starter is now archived in favor of [`gatsby-theme-mdx-deck`](https://github.com/jxnblk/mdx-deck/tree/master/packages/gatsby-theme). Thanks for your interest 💜

---

# gatsby-starter-deck

[![dependencies](https://img.shields.io/david/fabe/gatsby-starter-deck.svg)](./package.json)

[![deploys by netlify](https://img.shields.io/badge/deploys%20by-netlify-00c7b7.svg)](https://www.netlify.com)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

Create presentations using Gatsby, React & Markdown. Inspired by Guillermo Rauch’s [deck on Next.js](https://deck.now.sh/) and [mdx-deck](https://github.com/jxnblk/mdx-deck).

➡️ **[See a live example](//gatsby-deck.netlify.com)**

## Installation

### With [`gatsby-cli`](https://www.npmjs.com/package/gatsby-cli)

```bash

$ gatsby new my-slides https://github.com/fabe/gatsby-starter-deck

```

### With `git clone`

```bash

$ git clone [email protected]:fabe/gatsby-starter-deck.git my-slides

$ cd my-slides

$ yarn

```

## Usage

Edit and extend your slides inside the `src/slides.md` file. Navigate with the arrow keys.

```bash

# To develop & write

$ yarn develop

# To build

$ yarn build

```

## Writing

By default, use [src/slides/](src/slides/).

Markdown files are loaded in sorted path order. Slides are generated by

splitting each markdown file along `
` elements (`---` in Markdown lingo).


Examples:

```md

# This is the first slide

---

## This is the second slide

![Monkey](//i.imgur.com/PnbINJ6.gif)

```

## Authors

- Fabian Schultz ([@fschultz\_](https://twitter.com/fschultz_))

- Frank Murphy ([AnIrishDuck](https://github.com/AnIrishDuck))

- Stefan Probst ([stefanprobst](https://github.com/stefanprobst))