Writing Studio

Obsidian Writing Studio

Version 2.1.9 · Desktop only

Transform Obsidian into a professional writing environment. Writing Studio bundles a project binder, writing sprints, focus and typography modes, session word count tracking, manuscript export, WordPress publishing, a daily writing log, and a folder sidebar explorer into a single plugin.

---

Installation

1. Download main.js, manifest.json, and styles.css from the latest GitHub release.
2. Create the folder <vault>/.obsidian/plugins/obsidian-writing-studio/ if it does not exist.
3. Copy the three files into that folder.
4. In Obsidian, go to Settings → Community Plugins, find Writing Studio, and enable it.

Building from source: Clone the repository, run npm install, then npm run build. Copy the three output files as above.

---

Security

Every push and pull request is scanned automatically:

Results are published to the Security tab of this repository (GitHub code scanning).

For local development, a pre-commit hook runs ESLint (blocking) and a pre-push hook runs a full CodeQL scan (blocks the push if any HIGH or CRITICAL findings are present). Install the CodeQL CLI to enable local scanning (winget install GitHub.CodeQL on Windows).

---

Features

Writing Studio Launcher

The Launcher is a left-sidebar dashboard that shows your active project, word count and goal progress, writing mode controls, sprint timer, today's writing stats, and quick-action buttons for the most common Writing Studio tasks.

By default it opens automatically when Obsidian loads. To disable this, turn off Open on startup in Settings → General.

To open manually: Click the feather ribbon icon, or assign a hotkey to Open launcher in Settings → Hotkeys.

The Launcher includes:

• Active project name, total word count, and progress toward your project word count goal
• Writing mode selector (Draft / Edit / Review)
• Focus Mode and Typography Mode toggles
• Sprint timer with quick-start presets (10 m, 15 m, 25 m)
• Today card showing words written, sprints completed, session word count, and streak
• Quick-action buttons: Targets Dashboard, Writing Dashboard, Preview manuscript, Export, Writing Log, Publish to WordPress

---

Writing Binder

The Binder is a left-sidebar project panel that lists all documents in your active writing project. Each document shows its title, type (Chapter, Section, Article, Note), status (Draft, In Progress, Complete), and live word count. Documents can be reordered by drag-and-drop and toggled in or out of export.

To open: Use the command Open binder from the command palette, or assign a hotkey in Settings → Hotkeys.

Adding a file to a project:

1. Right-click any Markdown file in the file explorer and choose Add to writing project under Writing studio options.
2. A modal appears with a dropdown listing all your writing projects.
3. Select the target project and click Add to project.

---

Writing Modes

Three modes shape how the editor behaves. The current mode is always shown in the status bar. Click the mode pill in the status bar to switch modes.

To switch modes:

• Click the mode indicator in the status bar.
• Right-click inside the editor, then choose Switch writing mode → under Writing studio options.
• Assign hotkeys to Switch to draft mode / Edit mode / Review mode in Settings → Hotkeys.
• Use the Writing Studio Launcher panel.

The active mode persists across Obsidian restarts.

---

Focus Mode

Focus Mode dims everything in the editor except the paragraph or sentence you are currently writing, reducing visual noise and keeping attention on the active thought.

To toggle: Assign a hotkey to Toggle focus mode in Settings → Hotkeys, or use the toggle in the Launcher panel. Press Escape to exit.

Settings (Settings → Focus mode):

---

Typography Mode

Typography Mode applies a consistent, reader-friendly text treatment to the editor: a curated font, constrained line length, controlled line height, and optional letter spacing.

To toggle: Assign a hotkey to Toggle typography mode in Settings → Hotkeys, or use the toggle in the Launcher panel.

To change the font while Typography Mode is active: Right-click inside the editor and choose Typography font → under Writing studio options. A font picker menu appears with all available fonts; the active font is shown with a checkmark. Selecting a font applies it immediately and saves the setting.

Note on fonts: Typography fonts are loaded from Google Fonts and require an internet connection the first time each font is used. After the initial load they are cached and work offline.

Settings (Settings → Typography):

Available fonts:

---

Writing Sprint Timer

The Sprint Timer runs a timed writing session. A countdown appears in the status bar and in a floating overlay. When the sprint ends, a summary modal shows words written, duration, and words-per-minute. The session is logged to sprint history and optionally appended to your Daily Note.

To start a sprint: Use the command Start writing sprint from the command palette, assign a hotkey in Settings → Hotkeys, or use the sprint quick-start buttons in the Launcher panel.

The sprint modal lets you set:

• Duration (preset or custom, in minutes)
• Word count goal for the session
• Scope (current file or entire project)

Settings (Settings → Sprint & goals):

---

Word Count Goal

A per-document word count goal can be set and tracked inline.

To set a goal:

• Use the command Set word count goal from the command palette.
• Right-click inside the editor and choose Set word count goal under Writing studio options.

When a goal is set and Inline goal banner is enabled, a progress bar appears below the editor toolbar showing current words, goal, and percentage. It updates in real time as you type.

---

Session Word Count

The status bar shows a (+N) delta next to the current file's word count, indicating how many words you have added since opening that file this session. The Launcher's Today card also shows a cumulative session total across all files opened during the current Obsidian session. Both counts reset when Obsidian restarts.

---

Project Word Count Goal

When an active project has a total word count goal set, a dedicated status bar item shows {current} / {goal} project words. This updates automatically as you write. Set a project goal in the Project modal when creating or editing a project.

---

Writing Dashboard

The Writing Dashboard shows session statistics (words written, sprints completed, time), sprint history, daily progress toward your goal, and per-project word counts with reading time.

To open: Use the command Open writing dashboard from the command palette, or click the Writing dashboard button in the Launcher panel.

---

Targets Dashboard

The Targets Dashboard lets you assign word count goals to individual documents in the active project's binder and track progress across the whole project at a glance. Goals can be edited inline in the table. Rows are sortable and filterable by status.

To open: Use the command Open targets dashboard, click the Targets dashboard button in the Launcher panel, or assign a hotkey in Settings → Hotkeys.

---

Daily Writing Log

The Writing Log is a sidebar panel that shows your writing history at a glance.

To open: Use the command Open writing log from the command palette, or click the Writing log button in the Launcher panel.

The Writing Log shows:

• Current streak (days in a row with at least one sprint)
• This session: total session words, sprint words, sprints completed, and minutes written
• Last 30 days: a bar chart with one row per day showing word count, sprints completed, and a visual bar proportional to the day's output

When Append to daily note is enabled (Settings → Writing log), a summary of each completed sprint is also appended to today's Daily Note.

---

Project Manager

Projects group a set of documents (binder items) and act as the scope for export, statistics, and the word count goal banner.

To create a project: Use the command New writing project from the command palette, or click + New in the Launcher panel.

To switch projects: Use the Launcher panel or the project selector at the top of the Binder panel.

Each project stores:

• Title, type, author, and description
• Ordered binder with chapters, sections, articles, and notes
• Per-item word count goals, statuses, and export flags
• Optional total word count goal (shown in the Launcher and status bar)

Project templates available at creation:

---

Compile Preview

The Compile Preview opens a split pane showing all binder documents for the active project concatenated in order, rendered as a finished manuscript.

To open: Use the command Preview compiled manuscript from the command palette, or click the Preview manuscript button in the Launcher panel.

---

Export Engine

The Export Engine converts the current document or the active project's compiled manuscript to a finished file.

Supported formats: Manuscript (HTML) · PDF · Word (.docx) · RTF · HTML · Markdown · EPUB

To export:

• Right-click inside the editor and choose Export this document under Writing studio options.
• Use the command Export document from the command palette.
• Click the Export button in the Launcher panel.
• Assign a hotkey to Export document in Settings → Hotkeys.

Manuscript format

The Manuscript format produces a self-contained HTML file formatted to industry-standard manuscript conventions:

• Courier New 12 pt, double-spaced, 1-inch margins
• Title page with project title, author name, approximate word count, and optional contact information
• Chapter headings in uppercase, page-break before each
• Scene breaks rendered as · · ·

No external tools are required for manuscript export.

Settings (Settings → Export):

Requirement: Pandoc must be installed for PDF, DOCX, RTF, HTML, and EPUB export. Download from pandoc.org. For PDF export, a LaTeX distribution (e.g. TeX Live or MiKTeX) is also required. Manuscript (HTML) export does not require Pandoc.

---

WordPress Publishing

Publish the current Markdown file directly to one or more WordPress sites using the WordPress REST API. The modal lets you choose the target site, set the post title, status, categories, tags, excerpt, and an optional scheduled publication date.

To publish:

• Right-click inside the editor and choose Publish to WordPress under Writing studio options.
• Use the command Publish to wordpress from the command palette.
• Click the Publish to WordPress button in the Launcher panel.
• Assign a hotkey to Publish to wordpress in Settings → Hotkeys.

Setting up a site (Settings → WordPress):

1. Click + add WordPress site.
2. Enter a nickname, the site URL (e.g. https://yourblog.com), and your WordPress username.
3. Generate an application password in WordPress under Users → Profile → Application passwords and paste it into the Application password field.
4. Click Test connection to verify.

Per-site options:

---

Folder Sidebar Explorer

The Folder Sidebar Explorer opens a navigable folder tree in a sidebar panel. You can browse subfolders, search by name or file content, sort the listing, preview files inline, and insert copied text directly into the active editor.

To open:

• Use the command Open folder in sidebar explorer from the command palette.
• Right-click any folder in the file explorer and choose Open in sidebar explorer under Writing studio options.
• Assign a hotkey in Settings → Hotkeys.

Browsing and navigation:

Search:

A search bar appears at the top of the folder list. Type your query and press Enter to run the search.

• Searches both folder/file names and file contents (.md and .txt files).
• Frontmatter is excluded from content search to avoid false positives from YAML fields.
• Name matches show the matched term highlighted in the result title.
• Content matches show a text snippet around the match with the term highlighted, plus a CONTENT badge to distinguish them from name matches.
• Results always search from the root folder you set, regardless of which subfolder you are currently browsing.
• Click × to clear the search and return to the normal folder view.

Sort:

A sort dropdown sits next to the search bar. Options:

Copy content to the editor:

When a Markdown file is open in preview mode, its text is selectable. To insert a passage into the active editor:

1. Select the text you want in the preview pane.
2. Click the ↩ insert selection button in the nav bar.
3. The selected text is inserted at the cursor position in the active editor.

The preview is read-only — you cannot edit the file from the sidebar.

Hover tooltips:

Hover over any file or folder in the list to see an information card:

The word count updates asynchronously from Obsidian's file cache and appears within a moment of hover.

---

Frontmatter Manager

Writing Studio automatically manages YAML frontmatter in your documents when Frontmatter auto-update is enabled. On every save it updates:

• word-count — current word count
• modified — last-modified date

The word-count-goal frontmatter field is read by the inline goal banner and the Word Count Goal modal.

---

Context Menus

Writing Studio adds items to Obsidian's right-click context menus. All Writing Studio items are grouped together under the heading Writing studio options to distinguish them from other plugins and Obsidian's built-in options.

Right-click inside an open document (editor menu)

Right-click a Markdown file in the file explorer

Right-click a folder in the file explorer

---

Commands Reference

No default hotkeys are assigned. All commands can be given a hotkey in Settings → Hotkeys.

---

Ribbon Icon

Writing Studio adds a single icon to the Obsidian ribbon.

All other features are accessible from the Launcher panel, the command palette, context menus, or assigned hotkeys.

---

Settings Overview

Open via Settings → Writing Studio.

---

Requirements