Git Product home page Git Product logo

deck's Introduction

Continuous Integration Crate Status Docs Status

Deck

Deck is a command line tool that generates HTML presentations from Markdown documents.

Input

Slides are written in Markdown. Horizontal rules (---) are used to separate each slide.

Usage

Build

A Markdown file can be converted to an HTML presentation with a single command in a single file. By default, the generated HTML contains some inline CSS and Javascript to render the slides correctly. If you wish to customize the output a bit more you pass additional CSS and Javascript files using either the --css and --js options. The resulting document can be open in most modern browsers.

deck build < slides.md > slides.html

Serve

You also have the possibility to serve Markdown slides using the built-in server. The following command makes the presentation available at http://localhost:8000/slides:

deck serve slides.md -p 8000

When writing your presentation, it might come in handy to see the resulting HTML presentation evolves as you write. Adding -w to the previous command and ?watch=true to the previous URL will ensure that the web page is reloaded as soon as either the Markdown slides, the custom css or the customm js are modified.

Syntax highlighting

Syntax highlighting can be customized in various ways. First, both build and serve commands allow you to choose a different theme using the --theme option. By default only a handful of themes are available as listed here.

deck build --theme InspiredGitHub < slides.md > slides.html

In addition, syntect, the crate doing all the heavy lifting of highlighting the code, is able to load all TextMate and Sublime Text .tmTheme color schemes. In order to load a local theme, you must first add its directory to the list of paths where the binary will look for compatible themes and then select it using --theme. Given that the gruvbox.tmTheme is under the directory ./themes the command invocation could look like:

deck build --theme-dir ./themes --theme gruvbox < slides.md > slides.html

Todos

  • Speaker notes
  • Timer

deck's People

Contributors

fdehau avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

deck's Issues

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.