Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fredeil/gh-presentation
Markdown presentations using GitHub Pages, Jekyll and Reveal.js
https://github.com/fredeil/gh-presentation
jekyll markdown presentation-framework revealjs sass
Last synced: 23 days ago
JSON representation
Markdown presentations using GitHub Pages, Jekyll and Reveal.js
- Host: GitHub
- URL: https://github.com/fredeil/gh-presentation
- Owner: fredeil
- License: mit
- Created: 2018-04-17T11:17:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-29T18:28:18.000Z (over 6 years ago)
- Last Synced: 2024-11-09T14:30:21.453Z (3 months ago)
- Topics: jekyll, markdown, presentation-framework, revealjs, sass
- Language: CSS
- Homepage: https://fredeil.github.io/gh-presentation/
- Size: 1.57 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **GitHub Markdown Presentation** :balloon:
A simple template for creating presentations on the web hosted using GitHub Markdown You can also serve it locally if you don't want to upload your presentation online.
## Getting started
Fork the repo and edit `_config.yml` and then activate [GitHub Pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/) in the repo settings on the `master` branch.
This project depends on Ruby and github-pages gem.
### **1. Installing Ruby and dependencies:**
For Windows (using Chocolatey package manager):
```bash
$ choco install ruby
...
```
For macOS (using Homebrew package manager):
```bash
$ brew install ruby
...
```
For Ubuntu (using apt):
```bash
$ sudo apt-get install ruby-full
...
```
After installing please verify the version by running:
```bash
$ ruby -v
ruby 2.5.1p57 (2018-03-29 revision 63029) [x64-mingw32]
```
Life should be great right now, install the project dependencies
```
$ gem install github-pages
...
```
### **2. Running the project**
Clone the forked repository to your computer
```bash
$ git clone https://github.com/username/gh-presentation.git
$ cd gh-presentation
$ jekyll serve
...
```
The site should now be served on http://localhost:4000 and it should be listening for changes in your markup.
## **3. Creating content**
To create new slides you will have to use [GitHub Markdown](https://guides.github.com/features/mastering-markdown/).
All the slides are located under the `_posts` folder. To see an overview of all the slides you can use `esc` on your keyboard to get an idea of how the numbers (e.g. `1000-01-01-intro.md`) work on each slide.
## **Upcoming features:**
* Exporting to PDF
* Notes for the presenter
* WebSockets for broadcasting the presentation to multiple users
## **Contributing:**
Please contribute by creating issues, pull requests or staring this repo even :rocket: