aboutsummaryrefslogtreecommitdiff
path: root/README.html
blob: 3f586ded4b2bb4ce6c24304f986123b7fb71457a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<style>
@import "http://fonts.googleapis.com/css?family=Open Sans:regular,semibold,italic,italicsemibold|Inconsolata&amp;v2";
body {
  font-family: "Open Sans";
  margin: 6em 2em 2em 2em;
}
body:before {
  content: '';
  position: fixed;
  top: 2%;
  right: 3%;
  height: 100px;
  width: 100px;
  background: url(http://www.html5rocks.com/static/images/identity/HTML5_Badge_128.png) no-repeat 50% 50%;
  background-size: contain;
  z-index: 10;
}
h1, h2, h3, h4 {
  font-weight: 600;
}
h1 {
  position: fixed;
  background: -webkit-linear-gradient(top, rgb(238,238,238) 65%, rgba(238,238,238,0));
  background: -moz-linear-gradient(top, rgb(238,238,238) 65%, rgba(238,238,238,0));
  background: -ms-linear-gradient(top, rgb(238,238,238) 65%, rgba(238,238,238,0));
  background: -o-linear-gradient(top, rgb(238,238,238) 65%, rgba(238,238,238,0));
  width: 100%;
  height: 80px;
  padding: 10px 10px 10px 1em;
  left: 0;
  top: 0;
  margin: 0;
}
h1 img {
  height: 30px;
  vertical-align: middle;
  margin-bottom: 8px;
}
a { color: navy; }
pre {
  background: #eee;
  margin-left: 2em;
  padding: 5px;
  border-left: 3px solid #ccc;
}
</style>

<h1><img src="images/io2012_logo.png"> HTML5 Slide Template</h1>

<h2>Configuring the slides</h2>
<p>Much of the deck is customized by changing the settings in <a href="slide_config.json"><code>slide_config.json</code></a>.
Some of the customizations include the title, Analytics tracking ID, speaker
information (name, social urls, blog), web fonts to load, themes, and other
general behavior.</p>
<h3>Customizing the <code>#io2012</code> hash</h3>
<p>The bottom of the slides include <code>#io2012</code> by default. If you'd like to change
this, please update the variable <code>$social-tags: '#io2012';</code> in
<a href="theme/scss/default.scss"><code>/theme/scss/default.scss</code></a>.</p>
<p>See the next section on "Editing CSS" before you go editing things.</p>
<h2>Editing CSS</h2>
<p><a href="http://compass-style.org/install/">Compass</a> is a CSS preprocessor used to compile
SCSS/SASS into CSS. We chose SCSS for the new slide deck for maintainability,
easier browser compatibility, and because...it's the future!</p>
<p>That said, if not comfortable working with SCSS or don't want to learn something
new, not a problem. The generated .css files can already be found in
(see <a href="theme/css"><code>/theme/css</code></a>). You can just edit those and bypass SCSS altogether.
However, our recommendation is to use Compass. It's super easy to install and use.</p>
<h3>Installing Compass and making changes</h3>
<p>First, install compass:</p>
<pre><code>sudo gem update --system
sudo gem install compass
</code></pre>
<p>Next, you'll want to watch for changes to the exiting .scss files in <a href="theme/scss"><code>/theme/scss</code></a>
and any new one you add:</p>
<pre><code>$ cd io-2012-slides
$ compass watch
</code></pre>
<p>This command automatically recompiles the .scss file when you make a change.
Its corresponding .css file is output to <a href="theme/css"><code>/theme/css</code></a>. Slick.</p>
<p>By default, <a href="config.rb"><code>config.rb</code></a> in the main project folder outputs minified
.css. It's a best practice after all! However, if you want unminified files,
run watch with the style output flag:</p>
<pre><code>compass watch -s expanded
</code></pre>
<p><em>Note:</em> You should not need to edit <a href="theme/scss/_base.scss"><code>_base.scss</code></a>.</p>
<h2>Running the slides</h2>
<p>The slides can be run locally from <code>file://</code> making development easy :)</p>
<h3>Running from a web server</h3>
<p>If at some point you should need a web server, use <a href="serve.sh"><code>serve.sh</code></a>. It will
launch a simple one and point your default browser to <a href="http://localhost:8000/template.html"><code>http://localhost:8000/template.html</code></a>:</p>
<pre><code>$ cd io-2012-slides
$ ./serve.sh
</code></pre>
<p>You can also specify a custom port:</p>
<pre><code>$ ./serve.sh 8080
</code></pre>
<h3>Presenter mode</h3>
<p>The slides contain a presenter mode feature (beta) to view + control the slides
from a popup window.</p>
<p>To enable presenter mode, add <code>presentme=true</code> to the URL: <a href="http://localhost:8000/template.html?presentme=true">http://localhost:8000/template.html?presentme=true</a></p>
<p>To disable presenter mode, hit <a href="http://localhost:8000/template.html?presentme=false">http://localhost:8000/template.html?presentme=false</a></p>
<p>Presenter mode is sticky, so refreshing the page will persist your settings.</p>
<hr />
<p>That's all she wrote!</p>