Last Updated: Sunday, 19 September 2021 at 12:58
novelWriter is a plain text editor designed for writing novels assembled from many smaller text documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta data syntax for comments, synopsis, and cross-referencing. It is designed to be a simple text editor that allows for easy organisation of text and notes, using human readable text files as storage for robustness.
The project storage is suitable for version control software, and also well suited for file synchronisation tools. All text is saved as plain text files with a meta data header. The core project structure is stored in a single project XML file. Other meta data is primarily saved as JSON files. See also the How Data is Stored section for more details.
Any operating system that can run Python 3 and has the Qt 5 libraries should be able to run novelWriter. It runs fine on Linux, Windows and macOS, and users have tested it on other platforms too. novelWriter can be run directly from the Python source, installed from the pip tool.
You can also download a minimal archive package of novelWriter tailored for your operating system. This package can be extracted anywhere on your computer, and a setup script can be run to create the necessary icons and file associations. See the setup instructions for your operating system for further details.
Version 1.5 introduces a few changes that will require you to make a few minor modifications to some of the headings in your project. It should be fairly quick and straightforward. Please see the Format 1.3 Changes section for more details.
- Website: https://novelwriter.io
- Documentation: https://novelwriter.readthedocs.io
- Source Code: https://github.com/vkbo/novelWriter
- Source Releases: https://github.com/vkbo/novelWriter/releases
- Issue Tracker: https://github.com/vkbo/novelWriter/issues
- Feature Discussions: https://github.com/vkbo/novelWriter/discussions
- PyPi Project: https://pypi.org/project/novelWriter
- Setup on Linux
- Setup on macOS
- Setup on Windows
- Other Setup Methods
- User Interface Overview
- Formatting Your Text
- Keyboard Shortcuts
- Typographical Notes
- Project Format Changes
- Novel Projects
- Novel Structure
- Project Notes
- Exporting Projects