introduction/index.html

   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">
   9
  10         <title>Getting Started with deck.js</title>
  11
  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">
  15
  16         <!-- Core and extension CSS files -->
  17         <link rel="stylesheet" media="screen" href="../core/deck.core.css">
  18         <link rel="stylesheet" media="screen" href="../extensions/goto/deck.goto.css">
  19         <link rel="stylesheet" media="screen" href="../extensions/menu/deck.menu.css">
  20         <link rel="stylesheet" media="screen" href="../extensions/navigation/deck.navigation.css">
  21         <link rel="stylesheet" media="screen" href="../extensions/status/deck.status.css">
  22         <link rel="stylesheet" media="screen" href="../extensions/hash/deck.hash.css">
  23         <link rel="stylesheet" media="screen" href="../extensions/scale/deck.scale.css">
  24
  25         <!-- Style theme. More available in /themes/style/ or create your own. -->
  26         <link rel="stylesheet" media="screen" href="../themes/style/web-2.0.css">
  27
  28         <!-- Transition theme. More available in /themes/transition/ or create your own. -->
  29         <link rel="stylesheet" media="screen" href="../themes/transition/horizontal-slide.css">
  30
  31         <!-- Basic black and white print styles -->
  32         <link rel="stylesheet" media="print" href="../core/print.css">
  33
  34         <script src="../modernizr.custom.js"></script>
  35 </head>
  36
  37 <body>
  38   <div class="deck-container">
  39
  40     <!-- Begin slides -->
  41     <section class="slide" id="title-slide">
  42         <h1>Getting Started with deck.js</h1>
  43     </section>
  44
  45     <section class="slide" id="how-to-overview">
  46         <h2>How to Make a Deck</h2>
  47         <ol>
  48                 <li>
  49                         <h3>Write Slides</h3>
  50                         <p>Slide content is simple&nbsp;HTML.</p>
  51                 </li>
  52                 <li>
  53                         <h3>Choose Themes</h3>
  54                         <p>One for slide styles and one for deck&nbsp;transitions.</p>
  55                 </li>
  56                 <li>
  57                         <h3>Include Extensions</h3>
  58                         <p>Add extra functionality to your deck, or leave it stripped&nbsp;down.</p>
  59                 </li>
  60         </ol>
  61     </section>
  62
  63     <section class="slide" id="quick-start">
  64       <h2>Quick Start</h2>
  65       <p>When you <a href="https://github.com/imakewebthings/deck.js/zipball/stable">download</a> deck.js, it will include a file named <code>boilerplate.html</code>. You can immediately start editing slides in this page and viewing them in your web browser. Later on, when you are comfortable customizing the deck, you can edit the various pieces of the boilerplate or make your own to suit your needs.</p>
  66     </section>
  67
  68     <section class="slide" id="markup">
  69         <h2>The Markup</h2>
  70         <p>Slides are just HTML elements with a class of <code>slide</code>.</p>
  71         <pre><code>&lt;section class=&quot;slide&quot;&gt;
  72        &lt;h2&gt;How to Make a Deck&lt;/h2&gt;
  73        &lt;ol&gt;
  74           &lt;li&gt;
  75              &lt;h3&gt;Write Slides&lt;/h3&gt;
  76              &lt;p&gt;Slide content is simple HTML.&lt;/p&gt;
  77           &lt;/li&gt;
  78           &lt;li&gt;
  79              &lt;h3&gt;Choose Themes&lt;/h3&gt;
  80              &lt;p&gt;One for slide styles and one for deck transitions.&lt;/p&gt;
  81           &lt;/li&gt;
  82           &hellip;
  83        &lt;/ol&gt;
  84     &lt;/section&gt;</code></pre>
  85     </section>
  86
  87     <section class="slide" id="themes">
  88         <h2>Style Themes</h2>
  89         <p>Customizes the colors, typography, and layout of slide&nbsp;content.</p>
  90         <pre><code>&lt;link rel=&quot;stylesheet&quot; href=&quot;/path/to/css/style-theme.css&quot;&gt;</code></pre>
  91         <h2>Transition Themes</h2>
  92         <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>
  93         <pre><code>&lt;link rel=&quot;stylesheet&quot; href=&quot;/path/to/css/transition-theme.css&quot;&gt;</code></pre>
  94     </section>
  95
  96     <section class="slide" id="extensions">
  97         <h2>Extensions</h2>
  98         <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>
  99
 100         <ul>
 101                 <li class="slide" id="extensions-goto">
 102                         <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.
 103                 </li>
 104
 105                 <li class="slide" id="extensions-hash">
 106                         <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.
 107                 </li>
 108
 109                 <li class="slide" id="extensions-menu">
 110                         <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.
 111                 </li>
 112
 113                 <li class="slide" id="extensions-navigation">
 114                         <strong>deck.navigation</strong>: Adds clickable left and right buttons for the less keyboard&nbsp;inclined.
 115                 </li>
 116
 117                 <li class="slide" id="extensions-status">
 118                         <strong>deck.status</strong>: Adds a page number indicator. (current/total)
 119                 </li>
 120
 121                 <li class="slide" id="extensions-scale">
 122                         <strong>deck.scale</strong>: Scales each slide to fit within the deck container using CSS Transforms for those browsers that support them.
 123                 </li>
 124         </ul>
 125
 126         <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>
 127     </section>
 128
 129     <section class="slide" id="nested">
 130         <h2>Nested Slides</h2>
 131         <p>That last slide had a few steps.  To create substeps in slides, just nest them:</p>
 132         <pre><code>&lt;section class=&quot;slide&quot;&gt;
 133       &lt;h2&gt;Extensions&lt;/h2&gt;
 134       &lt;p&gt;Core gives you basic slide functionality...&lt;/p&gt;
 135       &lt;ul&gt;
 136          &lt;li class=&quot;slide&quot;&gt;
 137             &lt;h3&gt;deck.goto&lt;/h3&gt;
 138             &lt;p&gt;Adds a shortcut key to jump to any slide number...&lt;/p&gt;
 139          &lt;/li&gt;
 140          &lt;li class=&quot;slide&quot;&gt;...&lt;/li&gt;
 141          &lt;li class=&quot;slide&quot;&gt;...&lt;/li&gt;
 142          &lt;li class=&quot;slide&quot;&gt;...&lt;/li&gt;
 143       &lt;/ul&gt;
 144     &lt;/section&gt;</code></pre>
 145     </section>
 146
 147     <section class="slide" id="elements-images">
 148         <h2>Other Elements: Images</h2>
 149         <img src="http://placekitten.com/600/375" alt="Kitties">
 150         <pre><code>&lt;img src=&quot;http://placekitten.com/600/375&quot; alt=&quot;Kitties&quot;&gt;</code></pre>
 151     </section>
 152
 153     <section class="slide" id="elements-blockquotes">
 154         <h2>Other Elements: Blockquotes</h2>
 155         <blockquote cite="http://example.org">
 156                 <p>Food is an important part of a balanced diet.</p>
 157                 <p><cite>Fran Lebowitz</cite></p>
 158         </blockquote>
 159         <pre><code>&lt;blockquote cite=&quot;http://example.org&quot;&gt;
 160       &lt;p&gt;Food is an important part of a balanced diet.&lt;/p&gt;
 161       &lt;p&gt;&lt;cite&gt;Fran Lebowitz&lt;/cite&gt;&lt;/p&gt;
 162     &lt;/blockquote&gt;</code></pre>
 163     </section>
 164
 165
 166     <section class="slide" id="elements-videos">
 167         <h2>Other Elements: Video Embeds</h2>
 168         <p>Embed videos from your favorite online video service or with an HTML5 video&nbsp;element.</p>
 169
 170         <iframe src="http://player.vimeo.com/video/1063136?title=0&amp;byline=0&amp;portrait=0" width="400" height="225" frameborder="0"></iframe>
 171
 172         <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>
 173     </section>
 174
 175     <section class="slide" id="digging-deeper">
 176         <h2>Digging Deeper</h2>
 177         <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>
 178     </section>
 179
 180     <!-- deck.navigation snippet -->
 181     <a href="#" class="deck-prev-link" title="Previous">&#8592;</a>
 182     <a href="#" class="deck-next-link" title="Next">&#8594;</a>
 183
 184     <!-- deck.status snippet -->
 185     <p class="deck-status">
 186         <span class="deck-status-current"></span>
 187         /
 188         <span class="deck-status-total"></span>
 189     </p>
 190
 191     <!-- deck.goto snippet -->
 192     <form action="." method="get" class="goto-form">
 193         <label for="goto-slide">Go to slide:</label>
 194         <input type="text" name="slidenum" id="goto-slide" list="goto-datalist">
 195         <datalist id="goto-datalist"></datalist>
 196         <input type="submit" value="Go">
 197     </form>
 198
 199     <!-- deck.hash snippet -->
 200     <a href="." title="Permalink to this slide" class="deck-permalink">#</a>
 201   </div>
 202
 203 <script src="../jquery.min.js"></script>
 204
 205 <!-- Deck Core and extensions -->
 206 <script src="../core/deck.core.js"></script>
 207 <script src="../extensions/hash/deck.hash.js"></script>
 208 <script src="../extensions/menu/deck.menu.js"></script>
 209 <script src="../extensions/goto/deck.goto.js"></script>
 210 <script src="../extensions/status/deck.status.js"></script>
 211 <script src="../extensions/navigation/deck.navigation.js"></script>
 212 <script src="../extensions/scale/deck.scale.js"></script>
 213
 214 <!-- Initialize the deck -->
 215 <script>
 216 $(function() {
 217         $.deck('.slide');
 218 });
 219 </script>
 220
 221 </body>
 222 </html>