An open API service indexing awesome lists of open source software.

https://github.com/wixette/fountain2html

A simple Node/JavaScript app to convert .fountain screenplays to HTML format, with non-latin charset support
https://github.com/wixette/fountain2html

formatter fountain markdown screenplay

Last synced: 3 months ago
JSON representation

A simple Node/JavaScript app to convert .fountain screenplays to HTML format, with non-latin charset support

Awesome Lists containing this project

README

          

# fountain2html

> 中文说明请见 [README.zh.md](README.zh.md)

A simple Node/JavaScript module to convert .fountain screenplays to HTML format,
with non-latin charset support.

Visit
[wixette.github.io/fountain2html/](https://wixette.github.io/fountain2html/) to
try it out online.

See the definition of Fountain format at [fountain.io](http://fountain.io/)

This project is partially derived from
[Fountain.js](https://github.com/mattdaly/Fountain.js), with the following
additional features:

- Non-latin charset support. E.g. Chinese character name preceded with the "at"
symbol `@`, CJK action paragraphs, CJK-friendly themes, etc.
- Commandline interface to convert a .fountain file to HTML.
- `@media print` support, enabling page-break when printing.
- Predefined print-friendly themes, including colorful and high-contrast themes.

## Use the Web application

Visit
[https://wixette.github.io/fountain2html/](https://wixette.github.io/fountain2html/)
to use the web application.

You can also host and run `index.html` locally with any web server.

In the web app, you can drag and drop, or upload a .fountain file to the page.
You can also input the screenplay text directly. The Fountain content will be
converted to HTML automatically. Then you can select a theme from the dropdown
menu. The converted HTML will be rendered in the page and ready for printing (to
a PDF file or to papers).

## Use the command-line utility

Make sure you have Node.js and all yarn dependencies installed:

```bash
yarn install
```

Then use the following command to convert a Fountain file to HTML:

```bash
node . --theme=default example.fountain > example.html
```

## Screenshots

### Default theme

![ScreenShot](./screenshots/001.png)

### Ocean theme

![ScreenShot](./screenshots/002.png)

### Dark theme

![ScreenShot](./screenshots/003.png)

### Colorful theme

![ScreenShot](./screenshots/004.png)

### Chinese screenplay, CJK theme

![ScreenShot](./screenshots/c001.png)

### Chinese screenplay, colorful theme

![ScreenShot](./screenshots/c002.png)