Obsidian Fountain

A live-preview-compatible plugin that adds support for editing fountain screenplays to Obsidian.

Installing

to install, simply use BRAT! (for now)

when prompted for a plugin repository, paste the following into the text field:

GamerGirlandCo/obsidian-fountain-revived

Contributing

To make changes to this plugin, first ensure you have the dependencies installed.

yarn install

Development

To start building the plugin with what mode enabled run the following command:

yarn run dev

Note: If you haven't already installed the hot-reload-plugin you'll be prompted to. You need to enable that plugin in your obsidian vault before hot-reloading will start. You might need to refresh your plugin list for it to show up.

Releasing

To start a release build run the following command:

yarn run build

_{This plugin was generated by (create-obsidian-plugin)[https://www.npmjs.com/package/create-obsidian-plugin]}

special thanks / credits

• the parser that this plugin uses is based on lezer-parser/markdown, with a several tweaks and changes, which you can examine for yourself here if interested.
  • the regexes that the parser utilizes are taken from jonnygreenwald/fountain-js.
• the original fountain plugin, developed by @Darakah
• @kometenstaub for helping me understand the codemirror API

License

See LICENSE.