obsidian-plugin/chuangcaleb_obsidian-fountain-editor
1
0
Fork 0
mirror of https://github.com/chuangcaleb/obsidian-fountain-editor.git synced 2026-07-22 08:50:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
254 commits 5 branches 25 tags 2.2 MiB
TypeScript 70%
CSS 19.6%
JavaScript 10.4%
Find a file
chuangcaleb 9f055eeb91 chore: tsconfig with lib:es2019
2026-05-27 20:19:41 +08:00
.changeset chore: version bump 1.4.0 2025-05-03 20:40:50 +08:00
.github build: skip zipping 2026-05-25 22:53:01 +08:00
docs refactor: extract out ai from content/docs 2026-05-25 23:47:34 +08:00
src fix: update tsconfig and import errors 2026-05-27 18:55:28 +08:00
.editorconfig Initial commit 2023-09-30 16:09:38 +08:00
.gitignore fix: isFountainEnabled always failing .fountain files for not being .md 2023-10-13 15:43:40 +08:00
.npmrc Initial commit 2023-09-30 16:09:38 +08:00
.prettierrc style: enforce prettier 2023-11-07 20:26:13 +08:00
.xo-config.cjs clean: remove unused import 2026-05-27 17:08:51 +08:00
AGENTS.md refactor: extract out ai from content/docs 2026-05-25 23:47:34 +08:00
CHANGELOG.md feat: allow wikilinks as valid Character syntax 2026-05-27 18:44:10 +08:00
LICENSE chore: add LICENSE 2023-10-03 21:05:41 +08:00
manifest.json 1.4.8 2026-05-27 19:01:57 +08:00
package.json 1.4.8 2026-05-27 19:01:57 +08:00
pnpm-lock.yaml chore: update deps 2026-05-25 23:16:38 +08:00
pnpm-workspace.yaml chore: update deps 2026-05-25 23:16:38 +08:00
README.md docs: shoutout bgrundmann/obsidian-fountain 2025-09-05 21:21:53 +08:00
rollup.config.js style: xo formatting 2026-05-25 23:09:31 +08:00
tsconfig.json chore: tsconfig with lib:es2019 2026-05-27 20:19:41 +08:00
version-bump.mjs fix: set consistent Fountain token width by character width (fixes #59) 2025-05-03 18:45:32 +08:00
versions.json 1.4.8 2026-05-27 19:01:57 +08:00

README.md

Obsidian Fountain Editor

An Obsidian plugin for Fountain syntax formatting in the editor.

banner

📺 Youtube Demo: Obsidian Fountain - Live Editor (Plugin Showcase)

Obsidian Downloads GitHub stars

🔗 Quicklinks

🔨 Usage

🏁 Quickstart

  1. 📥 Open the installation prompt in Obsidian (recommended)
    1. How to install Obsidian plugins (beginner) Link →
    2. Manual installation (advanced) Link →
  2. 📄 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
  3. 🎨 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

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

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

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

%%
You can use **Obsidian comment blocks** to escape into markdown too!

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

%%

🧰 Toolset

Markdown

A lightweight markup syntax that uses simple plaintext formatting for easy conversion other formats.

Obsidian ↗

A markdown-based note-taking app with a focus on knowledge management: linking and organizing information.

Fountain ↗

A lightweight markup syntax for writing screenplays with simple plaintext formatting — just like Markdown.

Fountain Editor - Obsidian Plugin

This plugin integrates Fountain syntax into Obsidian’s editor!

Other Plugins & External Tools

Effortlessly incorporate other Obsidian plugins, and external screenplay tools and apps!

Huh???

You: “I like your funny words, magic man! What are all these different names? I’m new to all this!” Read more →

🌟 Key Features

💰 100% Free

No premium tier, no hidden charges. Everything, for $0.

📝 Author with Obsidian

One app for your research, references, ideating, outlining, drafting, writing. All linked. Unopinionated workflow.

💱 Intuitive Hybrid Syntax

Fountain + Markdown. Interleaved and complementary, with simple design for opt-in and opt-out!

⚡ Supercharge with Other Plugins

2k+ Obsidian plugins to further extend custom functionality and create the perfect writing app just for you.

🔧 Fine-Tune Your Styles

Fully exposed CSS Variables, for every syntax token, to tweak to pixel perfection.

Tip

Full documentation wiki can be found at obsidian-fountain-editor.chuangcaleb.com. Check it out!

You may also want to check out the similar Obsidian Fountain plugin!