https://github.com/zsnout/simple-slideshows
A project enabling anybody to easily create beautiful slideshows from Markdown documents.
https://github.com/zsnout/simple-slideshows
Last synced: over 1 year ago
JSON representation
A project enabling anybody to easily create beautiful slideshows from Markdown documents.
- Host: GitHub
- URL: https://github.com/zsnout/simple-slideshows
- Owner: zSnout
- License: mit
- Created: 2023-05-09T12:37:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-15T01:22:44.000Z (about 3 years ago)
- Last Synced: 2025-03-28T23:35:07.022Z (over 1 year ago)
- Language: Astro
- Size: 475 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple Slideshows Starter Kit
Welcome to Simple Slideshows! If you haven't downloaded this project already, do
so now by running `git clone`.
```sh
git clone https://github.com/zSnout/simple-slideshows.git
```
To create new slideshow decks, add Markdown files to the `decks` folder. Simple
Slideshows will automatically create slides at each level 1 & 2 heading. For
example, this code...
```md
# Hello world
A presentation made with Simple Slideshows
## A slide
With some content.
```
...will generate two slides: a title slide for the level 1 heading, and a
standard slide for the level 2 heading.
## Slide Guidelines
Simple Slideshows doesn't support everything, but it can do most anything you'll
like. The heading of a slide automatically becomes its title, and everything
else is turned into content.
Simple Slideshows supports...
- Paragraphs
- Lists (unordered and ordered)
- Tables
- Code blocks
- LaTeX equations
- Background images
## Background Images
To mark something as a background image, write "background" in place of its alt
text.
```md
```
This makes the background cover the entire slide. Because of the cover behavior,
some of your image may be chopped off. To prioritize a certain side of the
image, add `b`, `t`, `r`, or `l` to the alt text, or a combination of two
directions.
```md
```
```md
```
## Theming
To change the theme of your slideshow, open `.astro/src/components/Layout.astro`
and change the class name of the `` tag to something other than
`z-slate-light`. Currently, there are ten themes available:
- z-slate-light
- z-slate-dark
- z-zinc-light
- z-zinc-dark
- z-gray-light
- z-gray-dark
- z-neutral-light
- z-neutral-dark
- z-stone-light
- z-stone-dark
If you know CSS, you can also customize your theme by opening `theme.postcss`
and modifying the styles included in it.
## Homepage information
To change the title and subtitle shown on your project's homepage, edit their
respective variables in `.env`.
## Slideshow meta-information
To add meta information to a slideshow, use simple YAML metadata.
```md
---
key_1: true
key_2: hello world
---
...
```
Currently, slideshows can adjust these options. More may be added in future
updates to Simple Slideshows.
```yaml
# Assigns the slideshow a category. This is
# visible on the homepage of your site.
category: Your category here
# Hides a slideshow from the homepage. It
# will still be accessible through URLs.
hidden: true
# Overrides the default title of your
# slideshow with a manual one.
title: Your slideshow title
```
## Publishing to Vercel and Netlify
To make working with the repo more ergonomic, the main Astro project underlying
Simple Slideshows is packed into an `.astro` folder. As such, the project output
will be located in `.astro/dist`, not `dist`. You may need to configure Vercel,
Netlify, and other cloud providers to handle this case.