Markdown Fiction Writer

A vscode extension for writers.

Some tools I wrote for writing, organizing and exporting fiction (short stories, novels) using markdown.

⚠ Warning: This extension is entering the beta phase This means, a major restructuring of settings and features will follow. Please make sure to remember/backup you settings if you want to reuse them with the newer version.

❗PreRelease The current stable version is 0.0.55. All further versions that will be published are pre-release versions. Please install the pre-release version only if you want to test out issues and try out some of the new feature, and help with testing and feedback. The beta is under heavy refactirng and restructuring so things might break now and then.

Features

This is a quick overview of the main features. Please read the Full Documentation to find out more about this extension.

• Enhanced text editing:

  • automatically insert new paragraph on ++enter++, or ++shift+enter++

  • solutions for writing dialogue using dialogue markers (like in some non-english languages), using either em-dash (—) or other marks.

  • autoreplace -- with —

  • solutions for writing dialogue using dialogue markers (like in some non-english languages), using either em-dash (—) or other marks.

  • more details

    

    

    

    

    

• Export/Combine files

  • combine multiple .md files into one single file.

  • export .md to other formats (like .doc or .docx)

    • uses pandoc

  • more details

    

• Split files

  • easily split large .md files into one multiple documents.

  

  • more details

• Use metadata to categorize text

  • Parse yaml metadata (either in document or as external .md.yml. file)

    

    • (1): The yaml metadata block. The first thing in the document.
    • (2): The Metadata tree view. Parses the metadata block.
    • (3), (4): Assigned keyword colors and badges

    

  • more details

• Analyze text

  • count words, phrases, standard pages

  • view word/phrase repetitions

  • more details

    

    

• Text formatting

  • cleaning up spaces
  • fixing dialogue lines, indents
  • fixing paragraph spaces (add/remove empty lines)
  • remove trailing spaces
  • more details

• Take Quick Notes

  • take short notes and associate them with markdown (.md) files.

    

  • more details

• View

  • writing mode: quickly toggle font size, theme, zenMode and focusMode

    

  • fold paragraph lines

    

  • status bar icons

    

  • typewriter mode

  • more details

Known Issues

As this plugin rebinds some keys, like:enter, shift+enter, delete, tab, backspace, it can interfear with other extensions that also overwrite this keybindings.

Consider inspecting and rebinding some of them, as described here: Key Bindings for Visual Studio Code

Contributing

• File bugs, feature requests in GitHub Issues.

Release Notes

The current version is an early concept. Features are still missing, and not all features are thoroughly tested, or have reached a stable version.

View Changelog

For more information

• Full Documentation
• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!