demoit

command module
Version: v0.0.0-...-5762b16 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

README

DemoIt

DemoIt is a tool that helps you create beautiful live-coding demonstrations.

Why?

I'm doing lots of live-coding during conferences and I like tools like reveal.js to create slides. What I wanted was a tool that has some of the properties of reveal.js but with capabilities to code and run commands in front of the audience.

Two things are really important to me:

  • For a given presentation, the slides should live in the same repository as the code.
  • The tool should allow context-switching-less live coding demos. Attendees don't want to watch me switching between a browser, an IDE and a terminal all the time.

This is how I came up with DemoIt.

How?

DemoIt is a small command line tool written in Go. It serves rich web content composed of text, images and smart web components.

Those web components make most of the magic.

  • One component displays multi-tab ttys that can be used to run any command.
  • Another is a web browser view that auto refreses itself.
  • Another is a code viewer with highlighing and tabs that look like a real IDE,

How do I use Demoit?

Documentation is really sparse right now. The best one can do is install the tool using the following instructions and learn from the sample.

Basically, the idea is to:

  • Add a demoit.html at the root of the project. This file contains all the html slides separated with ---.
  • Add images, fonts and scripts in a .demoit folder at the root of the project.
  • Customize the style sheet in .demoit/style.css.
  • sample/demoit.html demonstrates how to use the web components.

See Run Demo for setting up and running a demo to get started with your first presentation.

Install

Clone and install
go get -u github.com/dgageot/demoit

As any go application, it will download demoit's sources to your $HOME/go/src/github.com/dgageot/demoit folder.
Add $HOME/go/bin/ directory to your $PATH in order to be able to call any go executable (including demoit) to your path.

Build it
cd $HOME/go/src/github.com/dgageot/demoit
go install -mod=vendor
Add shell font

To have a correct display in the web terminal, you have to install the font Inconsolata for Powerline on your computer.
This font can be found here.

Run Demo

cd $HOME; mkdir my_demoit_presentations; cd $HOME/my_demoit_presentations
cp -r $HOME/go/src/github.com/dgageot/demoit/sample .
demoit sample

Then, browse to http://localhost:8888

Pro tip: Run demoit -dev sample instead and enjoy live reload each time you change the content of the slides.

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
sample

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL