Giter Club home page Giter Club logo

understate's Introduction

understate

Build Status

Make stunning terminal presentations using markdown and some ncurses magic.

Overview

Understate renders regular markdown file into beautiful ascii art presentation that runs in your terminal.

Highlights:

  • A curses console application. No GUI whatsoever.
  • Uses standard markdown syntax. No learning curve.
  • Syntax highlighting for almost any programming language using Pygments.
  • Lightweight and cross platform.
  • Cool slide transitions (coming in version 0.3)

Install

The easiest way is to use pip (or pip2 if your default is python3):

$ pip install understate 

Otherwise, just use:

$ sudo make install

Usage

$ understate filename.md

Compatibility

Understate requires python 2.7 and was tested in the following terminals:

  • iTerm
  • Mac Terminal
  • rxvt

Roadmap

  • version 0.1 - Basic project structure
  • version 0.2 - Limited Markdown Support, Curses Renderer, Forward Navigation
  • version 0.3 - Config File, More Markdown Elements, Simple Transition Effect
  • version 0.4 - Slide Navigation, Status Bar, PIP integration
  • version 0.5 - More Transition Options and Effects

understate's People

Contributors

ithailevi 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.