/unity-tooling-presentation-nov-2014

Primary LanguageF#

FsReveal

FsReveal allows you to write beautiful slides in Markdown and brings F# to the reveal.js web presentation framework.

Features

  • Write your slides in Markdown or .fsx files
  • Syntax highlighting for most programming languages including C#, F# and LaTeX
  • Speaker notes; Shows the current slide, next slide, elapsed time and current time
  • Built in themes
  • Horizontal and vertical slides
  • Built in slide transitions using CSS 3D transforms
  • Slide overview
  • Works on mobile browsers. Swipe your way through the presentation.

Getting Started

Clone or download the FsReveal repository. Check out GitHub's links to the right if you need some help.

Prerequisites

If you are using Linux or OS X, you need to install Mono.

Windows users don't need to install anything.

Create

Open slides/input.md in your favourite text editor.

This is the source for your entire presentation. Inside you will find an example presentation that demonstrates how to use FsReveal.

Images

Put images into the slides/images folder.

Build

Open a console/terminal in the FsReveal folder.

If you're using Windows run

build.cmd

If you're using a Mac run

./build.sh

This will download all of the packages that FsReveal needs to create your slides.

Your slides are then generated and saved to the output folder.

A web server will start automatically and your presentation will be opened in your browser.

FsReveal will detect changes to your slides and generate them again for you; you just need to refresh your browser.

We're working on auto refreshing the browser for you.

Use

  • Use the arrow keys to navigate left, right, up and down
  • Press Esc to see an overview
  • Press f to view in fullscreen
  • Press s to see speaker notes.

Examples

Check out what others have created. Submit a PR if you have something to add to the list.