melodykramer / 18f

for slides

18F/slides

   #    #####               #                                      
  ##   #     # ######      #   ####  #      # #####  ######  ####  
 # #   #     # #          #   #      #      # #    # #      #      
   #    #####  #####     #     ####  #      # #    # #####   ####  
   #   #     # #        #          # #      # #    # #           # 
   #   #     # #       #      #    # #      # #    # #      #    # 
 #####  #####  #      #        ####  ###### # #####  ######  ####  
                                                                   

Why 18F/slides

You should use 18F/slides if you:

1. Can do Markdown,
2. Want a stupidly simple way to hack up a presentation,
3. Want a URL for your slide deck, and
4. Want git.

How to Use 18F/slides

To use 18F/slides:

1. Create a new markdown file in the _slides directory.

2. Add yaml frontmatter to the file with the following:

   ---
   layout: default
   path: path-to-url
   title: Title for 18F/slides
   ---
   

3. Create slides, using markdown syntax (technically, it's kramdown, go nuts).

4. Separate slides using --- for horizontal pagination between slides and -- for vertical pagination.

5. Commit the file to the gh-pages branch of the 18F/slides repo.

6. Profit. See example here.

How does it work?

18F/slides leverages the amazing open-source reveal.js library and jekyll and is hosted on github pages.

How can I make it better?

See CONTRIBUTING.md.