https://github.com/ducktordanny/presentation

Template for quickly creating presentations with reveal-md and then deploy to GitHub Pages right away
https://github.com/ducktordanny/presentation

presentation reveal-md template

Last synced: 26 days ago
JSON representation

Template for quickly creating presentations with reveal-md and then deploy to GitHub Pages right away

• Host: GitHub
• URL: https://github.com/ducktordanny/presentation
• Owner: ducktordanny
• License: mit
• Created: 2023-09-07T20:03:23.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-07T22:59:58.000Z (about 1 year ago)
• Last Synced: 2023-09-07T23:05:14.535Z (about 1 year ago)
• Topics: presentation, reveal-md, template
• Language: CSS
• Homepage: https://ducktordanny.github.io/presentation/
• Size: 1.79 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Presentation

> Boilerplate for creating presentations with reveal-md

## Install

Clone this repository, and that's it. Change it to your needs.

Install dependencies: `yarn` or `yarn install`

## Usage

The slides should be written inside the slides.md file, then run `yarn dev` to check it out (it will start it up in watch mode).

To build your changes use `yarn build` it will create a dist folder that you use later.

`yarn deploy` will take your dist folder and send it to GitHub Pages, so others can view it. Though if you create a repo from this template, there is a husky pre-push hook set up to deploy before every push, so you won't need to worry about doing this manually.

For more details on how some other configurations work, like custom styling etc. you can check the reveal-md lib, as this repo is based on that. A few information though:

- Edit `styles.css` for custom styles

- Edit `reveal-md.json` and `reveal.json` for reveal.js configurations

- Create your slides intside the `slides.md` file

## Note

This is just a template for future myself, but feel free to use it if you want.