Git Product home page Git Product logo

fsreveal-sample-md's Introduction

Issue Stats Issue Stats

FsReveal NuGet Status

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.

Styling

Create a custom stylesheet in slides/custom.css.

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.

Maintainer(s)

The default maintainer account for projects under "fsprojects" is @fsgit - F# Community Project Incubation Space (repo management)

fsreveal-sample-md's People

Contributors

carstenkoenig avatar dnauck avatar filipw avatar forki avatar kfuglsang avatar pblasucci avatar sergey-tihon avatar tpetricek avatar troykershaw avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.