Well Written

A multi-purpose "swiss army" tool for novel writers. Transform VS Code into a powerful novel writing environment with custom draft file format (.wrt), scene markers for organization, and repetition detection to improve your writing.

Features

📝 Draft Files (.wrt)

Custom file format optimized for creative writing with:

• Word wrap enabled by default
• Line numbers for easy reference
• Clean, distraction-free editing experience

🎬 Scene Markers

Organize your manuscript with hierarchical markers:

• $ for scenes (smallest division)
• $$ for chapters (medium division)
• $$$ for parts (largest division)

Features:

• ✨ Folding support - collapse/expand sections like Markdown headings
• 📑 Outline view - hierarchical navigation in sidebar
• 🔍 Breadcrumbs - see your current location
• 🎨 Theme-aware styling - works with both light and dark themes
• 📝 Empty markers allowed - plan your structure first, fill in later
• 🚫 Not compiled - markers are for organization only, excluded from final output

Example:

$$$ Part One - The Beginning

$$ Chapter 1 - Introduction

$ Scene 1 - The Arrival
Story content here...

$ Scene 2 - The Meeting
More content...

$
Empty scene (to be written later)

🔄 Repetition Mode

Highlight repeated words to improve your writing:

• 🎨 Color-coded - each repeated word gets unique color
• ⚡ Real-time updates - highlights update as you type
• 🔤 Case-insensitive - "Test", "test", "TEST" treated as same
• 📝 Apostrophe support - "don't", "can't", "won't" work correctly
• 🌍 International support - full Polish diacritics (ąćęłńóśźż)
• 🎯 Easy toggle - Ctrl+Alt+R to enable/disable

Use cases:

• Identify overused words
• Spot repetitive phrases
• Improve word variety
• Polish your prose

Quick Start

1. Create a draft file with .wrt extension
2. Add scene markers to organize your story:

   $$ Chapter 1
   $ Scene 1
   Your story text here...
   

3. Toggle repetition mode with Ctrl+Alt+R to check for repeated words
4. Use outline view (View > Outline) to navigate through scenes
5. Fold sections to focus on specific parts of your manuscript

Commands

Settings

Customize colors to match your preferences:

To customize:

1. Open Settings (Ctrl+,)
2. Search for "Well Written"
3. Modify colors to your preference

Scene Marker Navigation

Folding

• Click arrow icon next to scene marker to fold/unfold
• Ctrl+Shift+[ - Fold current section
• Ctrl+Shift+] - Unfold current section
• Ctrl+K Ctrl+0 - Fold all sections
• Ctrl+K Ctrl+J - Unfold all sections

Outline View

The extension provides document symbols that appear in VS Code's built-in outline view:

• Open the Outline panel in the Explorer sidebar (or View > Outline)
• See hierarchical structure: Parts > Chapters > Scenes
• Click any item to jump to that section
• Automatically updates as you edit

Breadcrumbs

VS Code's breadcrumbs feature works with scene markers:

• Enable breadcrumbs: View > Show Breadcrumbs
• Shows current location in document structure
• Click any level to see and navigate to other sections

Theme Compatibility

All features use theme-aware colors and work beautifully with:

• ✅ Light themes (Solarized Light, Light+, etc.)
• ✅ Dark themes (Dark+, Monokai, Dracula, etc.)
• ✅ High contrast themes

Requirements

• VS Code version 1.105.0 or higher

Known Limitations

• Repetition mode: Currently doesn't group word forms (e.g., "run", "running", "ran" are separate)
• Scene markers: Not yet compiled to output formats (coming in future versions)
• Word count: Not yet implemented for scenes (planned feature)

Release Notes

See CHANGELOG.md for detailed version history.

1.0.0 (2025-10-10)

Initial release with:

• .wrt draft file support
• Scene markers ($, $$, $$$)
• Repetition mode highlighting
• Folding and outline view integration
• Full Polish and English language support

Enjoy writing your novel! 📚✨