# novelWriter
**Repository Path**: shanyou/novelWriter
## Basic Information
- **Project Name**: novelWriter
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-12
- **Last Updated**: 2025-02-08
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# novelWriter
[](https://github.com/vkbo/novelWriter/actions/workflows/test_linux.yml)
[](https://github.com/vkbo/novelWriter/actions/workflows/test_win.yml)
[](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml)
[](https://github.com/vkbo/novelWriter/actions)
[](https://codecov.io/gh/vkbo/novelWriter)
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's 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.
For more details, and how to install and use novelWriter, please see the main website and
documentation.
**Project Links**
* Website: [novelwriter.io](https://novelwriter.io)
* Documentation: [docs.novelwriter.io](https://docs.novelwriter.io)
* Internationalisation: [crowdin.com/project/novelwriter](https://crowdin.com/project/novelwriter)
* PyPi Project: [pypi.org/project/novelWriter](https://pypi.org/project/novelWriter)
* Social Media: [fosstodon.org/@novelwriter](https://fosstodon.org/@novelwriter)
## Sponsors
![]() |
Free code signing on Windows provided by SignPath.io, certificate by SignPath Foundation. |