diff --git a/doc/PITCHME.md b/doc/PITCHME.md new file mode 100644 index 00000000000..86a188d4a5c --- /dev/null +++ b/doc/PITCHME.md @@ -0,0 +1,377 @@ +#HSLIDE + +## The Kitchen Sink +##### A GitPitch Feature Tour + +#HSLIDE +## Slideshow Theme Switcher +Available bottom-left of screen. | +Start switching themes right now! + +#HSLIDE + +## Tip! +For best viewing experience press **F** key to go fullscreen. + +#HSLIDE + +## Markdown Slides +Press Down key for details. | +See GitPitch Wiki for details. + + +#VSLIDE + +#### Use GitHub Flavored Markdown +#### For Slide Content Creation + +
+ +The same tool you use to create project **READMEs** and **Wikis** for your Git repos. + +#HSLIDE + +## Code Slides +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Use Markdown Code Blocks + +
+ +And enjoy code syntax highlighting for dozens of languages powered by highlight.js. + +#VSLIDE + +```JavaScript +// JavaScript Code Block + +$('button').click(function(){ + $('h1, h2, p').addClass('blue') + $('div').removeClass('important') + $('h3').toggleClass('error') + $('#foo').attr('alt', 'Lorem Ipsum') +}); +``` + +#VSLIDE + +```Scala +// Scala Code Block + +HashMap params = HashMap(n -> 10, mean -> 5) + +// Define executable for R stats#rnorm function call. +OCPUTask task = OCPU.R() + .pkg("stats") + .function("rnorm") + .input(params.asJava) + .library() +``` + +#VSLIDE + +```Go +// Go Code Block + +package main + +import "fmt" + +func swap(x, y string) (string, string) { + return y, x +} + +func main() { + a, b := swap("hello", "world") + fmt.Println(a, b) +} +``` + +#HSLIDE + +## GIST Slides +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### GitHub GIST +#### Building Blocks For Any Presentation + +
+ +Enjoy 100% reusable code snippets, excellent syntax highlighting, code indentation and styling. + +#VSLIDE?gist=8da53731fd54bab9d5c6 + +#VSLIDE?gist=28ee3d19ddef9d51b15adbdfe9ed48da + +#HSLIDE + +## Image Slides +## [ Inline ] +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Make A Visual Statement + +
+ +Use inline images to lend a *visual punch* to your slideshow presentations. + + +#VSLIDE + +Inline Image at Absolute URL + +![Image-Absolute](https://d1z75bzl1vljy2.cloudfront.net/kitchen-sink/octocat-privateinvestocat.jpg) + +the Private Investocat by jeejkang + + +#VSLIDE + +Inline Image at GitHub Repo Relative URL + +![Image-Absolute](assets/octocat-de-los-muertos.jpg) + +the Octocat-De-Los-Muertos by cameronmcefee + + +#VSLIDE + +Animated GIFs Work Too! + +![Image-Relative](https://d1z75bzl1vljy2.cloudfront.net/kitchen-sink/octocat-daftpunkocat.gif) + +the Daftpunktocat-Guy by jeejkang + +#HSLIDE + +## Image Slides +## [ Background ] +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Make A Bold Visual Statement + +
+ +Use high-resolution background images for maximum impact. + +#VSLIDE?image=https://d1z75bzl1vljy2.cloudfront.net/kitchen-sink/victory.jpg + +#VSLIDE?image=https://d1z75bzl1vljy2.cloudfront.net/kitchen-sink/127.jpg + + +#HSLIDE + +## Video Slides +## [ Inline ] +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Bring Your Presentations Alive + +
+ +Embed *YouTube*, *Vimeo*, *MP4* and *WebM* inline on any slide. + +#VSLIDE + +![YouTube Video](https://www.youtube.com/embed/dNJdJIwCF_Y) + +#VSLIDE + +![Vimeo Video](https://player.vimeo.com/video/125471012) + +#VSLIDE + +![MP4 Video](http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4) + + +#HSLIDE + +## Video Slides +## [ Background ] +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Maximize The Viewer Experience + +
+ +Go fullscreen with *MP4* and *WebM* videos. + +#VSLIDE?video=http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4 + +#HSLIDE + +## Math Notation Slides +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + + +#### Beautiful Math Rendered Beautifully + +
+ +Use *TeX*, *LaTeX* and *MathML* markup powered by MathJax. + +#VSLIDE + +`$$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$$` + +#VSLIDE + +`\begin{align} +\dot{x} & = \sigma(y-x) \\ +\dot{y} & = \rho x - y - xz \\ +\dot{z} & = -\beta z + xy +\end{align}` + +#VSLIDE + +##### The Cauchy-Schwarz Inequality + +`\[ +\left( \sum_{k=1}^n a_k b_k \right)^{\!\!2} \leq + \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right) +\]` + +#VSLIDE + +##### The probability of getting \(k\) heads when flipping \(n\) coins is: + +`\[P(E) = {n \choose k} p^k (1-p)^{ n-k} \]` + +#VSLIDE + +##### In-line Mathematics + +This expression `\(\sqrt{3x-1}+(1+x)^2\)` is an example of an inline equation. + +#HSLIDE + +## Slide Fragments +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Reveal Slide Concepts Piecemeal + +
+ +Step through slide content in sequence to slowly reveal the bigger picture. + +#VSLIDE + +- Java +- Groovy +- Kotlin +- Scala +- The JVM rocks! + +#VSLIDE + + + + + + + + + + + + + + + + + + + + + + +
FirstnameLastnameAge
JillSmith25
EveJackson94
JohnDoe43
+ +#HSLIDE +## PITCHME.yaml Settings +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Stamp Your Own Look and Feel + +
+ +Set a default theme, custom logo, custom css, background image, and preferred code syntax highlighting style. + +#VSLIDE + +#### Customize Slideshow Behavior + +
+ +Enable auto-slide with custom slide intervals, presentation looping, and RTL flow. + + +#HSLIDE +## Slideshow Keyboard Controls +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Try Out These Great Features Now! + +
+ +| Mode | On Key | Off Key | +| ---- | :------: | :--------: | +| Fullscreen | F | Esc | +| Overview | O | O | +| Blackout | B | B | +| Help | ? | Esc | + + +#HSLIDE + +## GitPitch Social +Press Down key for examples. | +See GitPitch Wiki for details. + +#VSLIDE + +#### Slideshows Designed For Sharing + +
+ +- View any slideshow at its public URL +- [Promote](https://github.com/gitpitch/gitpitch/wiki/Slideshow-GitHub-Badge) any slideshow using a GitHub badge +- [Embed](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Embedding) any slideshow within a blog or website +- [Share](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Sharing) any slideshow on Twitter, LinkedIn, etc +- [Print](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Printing) any slideshow as a PDF document +- [Download and present](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Offline) any slideshow offline + +#HSLIDE + +## GO FOR IT. +## JUST ADD PITCHME.md ;) \ No newline at end of file