Simplify packaged introduction deck, closes #64
[deck.js.git] / introduction / index.html
blobd0fc96c9c888cbc7313b4772c1ca84881761b310
1 <!DOCTYPE html>
2 <!--[if lt IE 7]> <html class="no-js ie6" lang="en"> <![endif]-->
3 <!--[if IE 7]> <html class="no-js ie7" lang="en"> <![endif]-->
4 <!--[if IE 8]> <html class="no-js ie8" lang="en"> <![endif]-->
5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6 <head>
7 <meta charset="utf-8">
8 <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
10 <title>Getting Started with deck.js</title>
12 <meta name="description" content="A jQuery library for modern HTML presentations">
13 <meta name="author" content="Caleb Troughton">
14 <meta name="viewport" content="width=1024, user-scalable=no">
16 <!-- Core and extension CSS files -->
17 <link rel="stylesheet" href="../core/deck.core.css">
18 <link rel="stylesheet" href="../extensions/goto/deck.goto.css">
19 <link rel="stylesheet" href="../extensions/menu/deck.menu.css">
20 <link rel="stylesheet" href="../extensions/navigation/deck.navigation.css">
21 <link rel="stylesheet" href="../extensions/status/deck.status.css">
22 <link rel="stylesheet" href="../extensions/hash/deck.hash.css">
24 <!-- Style theme. More available in /themes/style/ or create your own. -->
25 <link rel="stylesheet" href="../themes/style/web-2.0.css">
27 <!-- Transition theme. More available in /themes/transition/ or create your own. -->
28 <link rel="stylesheet" href="../themes/transition/horizontal-slide.css">
30 <script src="../modernizr.custom.js"></script>
31 </head>
33 <body class="deck-container">
35 <!-- Begin slides -->
36 <section class="slide" id="title-slide">
37 <h1>Getting Started with deck.js</h1>
38 </section>
40 <section class="slide" id="how-to-overview">
41 <h2>How to Make a Deck</h2>
42 <ol>
43 <li>
44 <h3>Write Slides</h3>
45 <p>Slide content is simple&nbsp;HTML.</p>
46 </li>
47 <li>
48 <h3>Choose Themes</h3>
49 <p>One for slide styles and one for deck&nbsp;transitions.</p>
50 </li>
51 <li>
52 <h3>Include Extensions</h3>
53 <p>Add extra functionality to your deck, or leave it stripped&nbsp;down.</p>
54 </li>
55 </ol>
56 </section>
58 <section class="slide" id="markup">
59 <h2>The Markup</h2>
60 <p>Slides are just HTML elements with a class of <code>slide</code>.</p>
61 <pre><code>&lt;section class=&quot;slide&quot;&gt;
62 &lt;h2&gt;How to Make a Deck&lt;/h2&gt;
63 &lt;ol&gt;
64 &lt;li&gt;
65 &lt;h3&gt;Write Slides&lt;/h3&gt;
66 &lt;p&gt;Slide content is simple HTML.&lt;/p&gt;
67 &lt;/li&gt;
68 &lt;li&gt;
69 &lt;h3&gt;Choose Themes&lt;/h3&gt;
70 &lt;p&gt;One for slide styles and one for deck transitions.&lt;/p&gt;
71 &lt;/li&gt;
72 &hellip;
73 &lt;/ol&gt;
74 &lt;/section&gt;</code></pre>
75 </section>
77 <section class="slide" id="themes">
78 <h2>Style Themes</h2>
79 <p>Customizes the colors, typography, and layout of slide&nbsp;content.</p>
80 <pre><code>&lt;link rel=&quot;stylesheet&quot; href=&quot;/path/to/css/style-theme.css&quot;&gt;</code></pre>
81 <h2>Transition Themes</h2>
82 <p>Defines transitions between slides using CSS3 transitions. Less capable browsers fall back to cutaways. But <strong>you</strong> aren&rsquo;t using <em>those</em> browsers to give your presentations, are&nbsp;you&hellip;</p>
83 <pre><code>&lt;link rel=&quot;stylesheet&quot; href=&quot;/path/to/css/transition-theme.css&quot;&gt;</code></pre>
84 </section>
86 <section class="slide" id="extensions">
87 <h2>Extensions</h2>
88 <p>Core gives you basic slide functionality with left and right arrow navigation, but you may want more. Here are the ones included in this&nbsp;deck:</p>
90 <ul>
91 <li class="slide" id="extensions-goto">
92 <strong>deck.goto</strong>: Adds a shortcut key to jump to any slide number. Hit g, type in the slide number, and hit&nbsp;enter.
93 </li>
95 <li class="slide" id="extensions-hash">
96 <strong>deck.hash</strong>: Enables internal linking within slides, deep linking to individual slides, and updates the address bar &amp; a permalink anchor with each slide&nbsp;change.
97 </li>
99 <li class="slide" id="extensions-menu">
100 <strong>deck.menu</strong>: Adds a menu view, letting you see all slides in a grid. Hit m to toggle to menu view, continue navigating your deck, and hit m to return to normal view. Touch devices can double-tap the deck to switch between&nbsp;views.
101 </li>
103 <li class="slide" id="extensions-navigation">
104 <strong>deck.navigation</strong>: Adds clickable left and right buttons for the less keyboard&nbsp;inclined.
105 </li>
107 <li class="slide" id="extensions-status">
108 <strong>deck.status</strong>: Adds a page number indicator. (current/total)
109 </li>
110 </ul>
112 <p class="slide" id="extension-folders">Each extension folder in the download package contains the necessary JavaScript, CSS, and HTML&nbsp;files. For a complete list of extension modules included in deck.js, check out the&nbsp;<a href="http://imakewebthings.github.com/deck.js/docs">documentation</a>.</p>
113 </section>
115 <section class="slide" id="nested">
116 <h2>Nested Slides</h2>
117 <p>That last slide had a few steps. To create substeps in slides, just nest them:</p>
118 <pre><code>&lt;section class=&quot;slide&quot;&gt;
119 &lt;h2&gt;Extensions&lt;/h2&gt;
120 &lt;p&gt;Core gives you basic slide functionality...&lt;/p&gt;
121 &lt;ul&gt;
122 &lt;li class=&quot;slide&quot;&gt;
123 &lt;h3&gt;deck.goto&lt;/h3&gt;
124 &lt;p&gt;Adds a shortcut key to jump to any slide number...&lt;/p&gt;
125 &lt;/li&gt;
126 &lt;li class=&quot;slide&quot;&gt;...&lt;/li&gt;
127 &lt;li class=&quot;slide&quot;&gt;...&lt;/li&gt;
128 &lt;li class=&quot;slide&quot;&gt;...&lt;/li&gt;
129 &lt;/ul&gt;
130 &lt;/section&gt;</code></pre>
131 </section>
133 <section class="slide" id="elements-images">
134 <h2>Other Elements: Images</h2>
135 <img src="http://placekitten.com/600/375" alt="Kitties">
136 <pre><code>&lt;img src=&quot;http://placekitten.com/600/375&quot; alt=&quot;Kitties&quot;&gt;</code></pre>
137 </section>
139 <section class="slide" id="elements-blockquotes">
140 <h2>Other Elements: Blockquotes</h2>
141 <blockquote cite="http://example.org">
142 <p>Food is an important part of a balanced diet.</p>
143 <p><cite>Fran Lebowitz</cite></p>
144 </blockquote>
145 <pre><code>&lt;blockquote cite=&quot;http://example.org&quot;&gt;
146 &lt;p&gt;Food is an important part of a balanced diet.&lt;/p&gt;
147 &lt;p&gt;&lt;cite&gt;Fran Lebowitz&lt;/cite&gt;&lt;/p&gt;
148 &lt;/blockquote&gt;</code></pre>
149 </section>
152 <section class="slide" id="elements-videos">
153 <h2>Other Elements: Video Embeds</h2>
154 <p>Embed videos from your favorite online video service or with an HTML5 video&nbsp;element.</p>
156 <iframe src="http://player.vimeo.com/video/1063136?title=0&amp;byline=0&amp;portrait=0" width="400" height="225" frameborder="0"></iframe>
158 <pre><code>&lt;iframe src=&quot;http://player.vimeo.com/video/1063136?title=0&amp;amp;byline=0&amp;amp;portrait=0&quot; width=&quot;400&quot; height=&quot;225&quot; frameborder=&quot;0&quot;&gt;&lt;/iframe&gt;</code></pre>
159 </section>
161 <section class="slide" id="digging-deeper">
162 <h2>Digging Deeper</h2>
163 <p>If you want to learn about making your own themes, extending deck.js, and more, check out the&nbsp;<a href="../docs/">documentation</a>.</p>
164 </section>
166 <!-- deck.navigation snippet -->
167 <a href="#" class="deck-prev-link" title="Previous">&#8592;</a>
168 <a href="#" class="deck-next-link" title="Next">&#8594;</a>
170 <!-- deck.status snippet -->
171 <p class="deck-status">
172 <span class="deck-status-current"></span>
174 <span class="deck-status-total"></span>
175 </p>
177 <!-- deck.goto snippet -->
178 <form action="." method="get" class="goto-form">
179 <label for="goto-slide">Go to slide:</label>
180 <input type="text" name="slidenum" id="goto-slide" list="goto-datalist">
181 <datalist id="goto-datalist"></datalist>
182 <input type="submit" value="Go">
183 </form>
185 <!-- deck.hash snippet -->
186 <a href="." title="Permalink to this slide" class="deck-permalink">#</a>
189 <!-- Grab CDN jQuery, with a protocol relative URL; fall back to local if offline -->
190 <script src="//ajax.aspnetcdn.com/ajax/jQuery/jquery-1.7.min.js"></script>
191 <script>window.jQuery || document.write('<script src="../jquery-1.7.min.js"><\/script>')</script>
193 <!-- Deck Core and extensions -->
194 <script src="../core/deck.core.js"></script>
195 <script src="../extensions/hash/deck.hash.js"></script>
196 <script src="../extensions/menu/deck.menu.js"></script>
197 <script src="../extensions/goto/deck.goto.js"></script>
198 <script src="../extensions/status/deck.status.js"></script>
199 <script src="../extensions/navigation/deck.navigation.js"></script>
201 <!-- Initialize the deck -->
202 <script>
203 $(function() {
204 $.deck('.slide');
206 </script>
208 </body>
209 </html>