18F/slides
# ##### #
## # # ###### # #### # # ##### ###### ####
# # # # # # # # # # # # #
# ##### ##### # #### # # # # ##### ####
# # # # # # # # # # # #
# # # # # # # # # # # # # #
##### ##### # # #### ###### # ##### ###### ####
Why 18F/slides
You should use 18F/slides if you:
- Can do Markdown,
- Want a stupidly simple way to hack up a presentation,
- Want a URL for your slide deck, and
- Want
git
.
How to Use 18F/slides
To use 18F/slides:
-
Create a new
.html
file in the_slides
directory. -
Add yaml frontmatter to the file with the following:
--- layout: default path: path-to-url title: Title for 18F/slides ---
-
Create slides, using markdown syntax (technically, it's redcarpet, go nuts).
-
Separate slides using
---
for horizontal pagination between slides and--
for vertical pagination. -
Commit the file to the
18f-pages
branch of the 18F/slides repo. -
Profit. See the sample slides to get a feel for how the navigation works.
How does it work?
18F/slides leverages the amazing open-source reveal.js library and jekyll and is hosted on Federalist.
How can I use this for my own slides?
If you'd like to use Slides for your own organization, here are some tips on how to fork it and get your own version:
- Fork! (of course)
- Edit _config.yml. Modify title/email and - critically - the "url" field to reflect your GitHub repository, e.g. https://github.com/18F/slides/ becomes https://slides.18f.gov. Make sure you commit to the 18f-pages branch so 18F Pages picks it up.
- Wait for a little while - Federalist is working behind the scenes for your initial setup, and if you try to actually view your slides right away, you'll probably get a 404. It sometimes takes 5-10 minutes; once it's set up initially, changes take effect pretty quickly.
- You'll presumably want to define your own theme, or pick one of the existing ones (take a look in ../assets/css/theme), and edit _layouts/default.html to reflect it. Look for the link with id="theme" in it.
- That's it! Enjoy your slides.
How can I make it better?
See CONTRIBUTING.md.