Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript CSS Perl
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
images
theme/html
README.md
atlas.json
index.html
presentation.html
sample.html
titlepage.html

README.md

Atlas presentation template

This is a template for a presentation in Atlas. (Or, what we're calling an "Atlascast".) It provides the basic instructions you need to follow to make a new presentation in Atlas.

Install the template into Atlas

In this pre-release version of Atlas, the first step in using the template is to get a fresh copy of it into your GitHub account. To do this, you'll need to clone the repository to your local machine, like this:

$ git clone --shallow https://github.com/oreillymedia/presentation-template.git

(Be sure to use the "--shallow" option so that you don't get the version history.) Once you download the template, you should create a new project on GitHub, and then add a remote on your local machine to your new presentation. For example:

$ cd presentation-template
$ git remote add github git@github.com:aliginedleft/scatteredtoscatterplot.git
$ git push gihub master

Once you've pushed the new repo up, you can open it in Atlas.

Build the presentation in Atlas

Every "slide" in Atlas must be wrapped in a "chapter" section. You can organize your slides by putting each one in its own file, or putting multipl "chapter" sections together in a single file.

Each slide can can contain any kind of content, such as:

  • plain text
  • lists
  • tables
  • hyperlinks
  • images

You can also use the "Insert Media" button to insert the HTML markup for:

  • YouTube or Vimeo videos
  • JSBins
  • Google form widgets (these are a simple way to have an interactive poll or form for your viewers)
  • Arbitratray iframes

Slides can also be laid-out using multiple columns for content, for example to present a list and an image side by side. Check out the presentation.html file for markup examples of multicolumn slides. You can use up to four columns by default.

The "sample.html" file in this template provides some ideas to try.

Create a title page

To create a title page, edit the "titlepage.html" file. This file will automatically be placed at the start of your presentation.

Create an index page

Edit the file "index.html" to create a landing page that describes the presentation. Unlike the other slides in this file, no default styles or layout are applied to this file, so you can pretty much design it how you like. We recommend that you include:

  • A description of the presentation
  • A brief bio and photograph
  • A brief list of topics covered in the talk

You can also create supplementary CSS files and apply them just to this index file, so that they don't affect your presentation. Just add links to these CSS files in the head of the index.html file.

Build the presentation

You build an Atlas presentation just like you build a book:

  • Use the theme named "oreillymedia/oreilly_presentation_theme"
  • Select In the HTML Build options, select the "Consolidate HTML in one File" option, like this:

images/build_atlas_presentation.png

  • Drag the files that contain your slides into the build
  • You can also build a pretty passable PDF to hand out after the fact.

Test the presentation on your local machine

Once you build the file, download and unzip it. If you're on a Mac, you can drop into a terminal and go to the directory where you unzipped it and run this:

python -m SimpleHTTPServer

If you're on a Windows machine, perhaps you'll be kind enough to submit a pull request that explains the best way to do this on Windows.

Publish the presentation

You can pubslih the HTML anywhere where you can host a static site. O'Reilly will work with you if you want to piublish it on an ORM domain.

Something went wrong with that request. Please try again.