Git Product home page Git Product logo

cookiecutter-remarkjs's Introduction

Cookiecutter remark.js

Cookiecutter template for remark.js presentations

See the official remark.js website for what's so cool about remark!

Features

  • Simple index.html file
  • Separate slides.css and slides.md files for ease of editing
  • Default styling in slides.css taken from the remark.js sample presentation
  • Presentation configuration in cookiecutter setup

Quickstart

  1. Install the latest Cookiecutter
    • pip install -U cookiecutter
  2. Create a presentation from this Cookiecutter
    • cookiecutter gh:malikoth/cookiecutter-remarkjs
  3. Edit content into slides.md. See the remark.js wiki for help setting up your slides
  4. Customize any css in slides.css
  5. Serve your presentation over HTTP using one of the following methods (or others)
    1. Commit your presentation to the gh-pages branch of a Git repository and push it to GitHub
    2. Serve the presentation from your local harddrive with Python, using either python -m SimpleHTTPServer or python3 -m http.server
  6. Enjoy the applause after presenting your amazing talk

Options

Option name Description Default
presentation_name The name of your presentation. This will also appear on the title slide My Presentation
project_slug The folder to store your presentation in my-presentation
mermaid Whether to link in Mermaid.js for pretty graphs or not true
highlight_language Default language for syntax highlighting python
highlight_style Default style for syntax highlighting monokai
highlight_lines Whether or not to highlight lines that start with an asterisk in code blocks true
aspect_ratio Aspect ratio for the presentation 4:3

cookiecutter-remarkjs's People

Contributors

malikoth avatar

Watchers

James Cloos 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.