eleventy-plugin-fountain

An Eleventy plugin for processing Fountain screenplay format files.

Installation

npm install eleventy-plugin-fountain

Usage

In your .eleventy.js config file:

import eleventyPluginFountain from 'eleventy-plugin-fountain';

export default function(eleventyConfig) {
  eleventyConfig.addPlugin(eleventyPluginFountain);
  
  return {
    // your config
  };
}

Options

You can customize the plugin behavior by passing options:

eleventyConfig.addPlugin(eleventyPluginFountain, {
  // Custom tags for fountain notes (comments)
  noteStartTag: '<span class="fountain-note">',
  noteEndTag: '</span>',
  
  // Custom template format name (default: 'fountain')
  templateFormat: 'fountain'
});

What it does

This plugin:

1. Registers .fountain files as a template format in Eleventy
2. Parses Fountain files using the fountain-js library
3. Converts Fountain comments (<!-- -->) to HTML spans with the class note
4. Outputs the rendered HTML for use in your Eleventy site

Fountain Format

Fountain is a simple markup syntax for writing screenplays. Learn more at fountain.io.

License

MIT