fountain

command module
v0.0.0-...-8fb46af Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2016 License: MIT Imports: 5 Imported by: 0

README

Build Status GoDoc Go Report Card codebeat badge

https://github.com/go-fountain/fountain

Fountain is a plain text markup language for screenwriting.

There's an example command-line utility fountain.go to demo the libraries, with a bin/ wrapper.

To build and install fountain to your machine:

make install

Then, to format a screenplay to terminal:

$ fountain format hello-world.fountain

...................
...................
...................
...................
...................
...................
Credit

Charney Kaye

Outright Mental

Fountain.io

Martin Vilcans for Screenplain

Element

An Element is a single block of content, spanning the full width of the page, for a limited vertical area.

GoDoc Coverage

Page

A Page is a vertical stack of Elements. Pagination is the ability to create a set of optimal pages from a set of elements.

GoDoc Coverage

Export

An Export is a .PDF file created from a set of Pages paginated from a set of Elements.

GoDoc Coverage

Documentation

Overview

Fountain is a plain text markup language for screenwriting.

There's an example command-line utility `fountain.go` to demo the libraries, with a `bin/` wrapper.

Build and install `fountain` to your machine

make install

Credit

Charney Kaye <hiya@charney.io> http://w.charney.io

Outright Mental http://w.outright.io

Fountain http://fountain.io

Martin Vilcans http://www.librador.com/ Screenplain https://github.com/vilcans/screenplain

Directories

Path Synopsis
A screenplay element might be an Action, Character, Dialogue, etc.
A screenplay element might be an Action, Character, Dialogue, etc.
An Export is a .PDF file created from a set of Pages paginated from a set of Elements.
An Export is a .PDF file created from a set of Pages paginated from a set of Elements.
A Page is a vertical stack of Elements.
A Page is a vertical stack of Elements.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL