Code Monkey home page Code Monkey logo

termnote's Introduction

TermNote

TermNote is a program that allows you to write presentations either in Ruby:

require 'termnote'

include TermNote

show.add chapter title: "Hello, World"
show.add code language: "ruby", source: <<-SOURCE
  puts "Hello, world!"
SOURCE
show.start

Or via a .yaml file:

---
type: chapter
title: Hello, World
subtitle: By Kurtis
---
type: code
source: |
  puts "Hello, world!"

and then with the termnote binary:

$ termnote someshow.yml

Here's an example of the slides in use:

Chapter Text List Code

You can then use j or k to navigate through the slides.

Installation

Install it yourself via:

$ gem install termnote

Usage

Usage is pretty simple, there are 4 types of slides:

  • Chapter, a single title [optional: and subtitle]
  • Text, a blob of text called content [optional: and title]
  • List, a list of items [optional: and title]
  • Code, a syntax highlighted blob called source

You can change the way things are printed out by overriding the classes for your specific presentation, but only if you do things programatically.

Ruby Usage Examples

Add a title slide

show.add chapter title: "Title Slide"

Add a text slide

show.add text title: "Content Title", content: "content blob"

Add a list slide

show.add list title: "title", items: ["item 1", "item 2", "item 3"]

Add a slide with code

show.add code langauge: "ruby", source: <<-SOURCE
  def method
    awesome = true
  end
SOURCE

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Contributors

termnote's People

Contributors

mileszs avatar halan avatar jessieay avatar

Watchers

James Cloos avatar Felix Yan 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.