⚡ Quick Start

🔨 Usage

🏁 Quickstart

📥 Open the installation prompt in Obsidian (recommended)
1. How to install Obsidian plugins (beginner) Link →
2. Manual installation (advanced) Link →
📄 Mark a markdown note for Fountain formatting by one of the following:
1. Use a .fountain.md extension
2. Add a fountain tag to the Properties frontmatter
3. Add cssclasses: fountain to the Properties frontmatter
🎨 You will get automatic syntax highlighting/styling according to the Fountain syntax!

Try copy-pasting this into a note:

---
cssclasses:
  - fountain
---

# Opening Hook

> THE STINK LINK <

FADE TO:

EXT. PUBLIC RESTROOM - DAY

= Use Fountain's Synopsis to escape into [[regular markdown]]! #so-cool

A POLICE OFFICER steps into a dingy restroom. She winces.

POLICE OFFICER (V.O.)
I _smell_ a rat...

> You can use `Obsidian blockquotes` to escape into markdown too!
> Make sure to enable the setting!

%%
You could use **Obsidian comment blocks** too!
%%

> [!tip] Strip these Obsidian comments out with the Obsidian Longform plugin!

💿 Manual Installation

🆕 You may install directly with BRAT using the link of this repo (https://github.com/chuangcaleb/obsidian-fountain-editor).
📤 You can also go to the repo’s Latest Releases page and manually download the obsidian-fountain-editor-[version].zip file, then extract it into your .obsidian/plugin directory!

🤝 Synergistic Tools

kevboh/longform: A plugin for Obsidian that helps you write and edit novels, screenplays, and other long projects.
Better Fountain - Visual Studio Code Extension: Fountain autocomplete, syntax highlighting, and export to PDF
MeepTech/obsidian-custom-file-extensions-plugin: An obsidian plugin allowing you to register and view different file extensions in a modular manner.
deathau/cm-typewriter-scroll-obsidian: Typewriter Scroll Obsidian Plugin

📖 Explore Synergistic Tools for details on how they work together with this plugin!