# ##### #
## # # ###### # #### # # ##### ###### ####
# # # # # # # # # # # # #
# ##### ##### # #### # # # # ##### ####
# # # # # # # # # # # #
# # # # # # # # # # # # # #
##### ##### # # #### ###### # ##### ###### ####
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
.
To use 18F/slides:
-
Create a new markdown 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 kramdown, go nuts).
-
Separate slides using
---
for horizontal pagination between slides and--
for vertical pagination. -
Commit the file to the
gh-pages
branch of the 18F/slides repo. -
Profit. See example here.
18F/slides leverages the amazing open-source reveal.js library and jekyll and is hosted on github pages.
See CONTRIBUTING.md.
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 account. Make sure you commit to the gh-pages branch so Github Pages picks it up.
- Wait for a little while - Github Pages 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.