Git Product home page Git Product logo

gh-presentation's Introduction

GitHub Markdown Presentation ๐ŸŽˆ

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 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):

$ choco install ruby
...

For macOS (using Homebrew package manager):

$ brew install ruby
...

For Ubuntu (using apt):

$ sudo apt-get install ruby-full
...

After installing please verify the version by running:

$ 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

$ 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.

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 ๐Ÿš€

gh-presentation's People

Contributors

fredeil avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.