Documentation for novelWriter#
novelWriter is an open source 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 the Project Storage 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. See Getting Started for more details.
Version 1.5 introduced 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.
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