Made a new pass of all the previously updated documentation files

This commit is contained in:
Veronica K. B. Olsen
2020-08-06 22:08:36 +02:00
parent cb8e0231d7
commit 21eebbb88f
10 changed files with 262 additions and 182 deletions
+53 -6
View File
@@ -1,10 +1,55 @@
########################################
Welcome to the novelWriter Documentation
########################################
#######################################
Documentation for novelWriter |release|
#######################################
This is the documentation for novelWriter |release|.
.. image:: https://travis-ci.com/vkbo/novelWriter.svg?branch=master
:target: https://travis-ci.com/vkbo/novelWriter
:alt: Build Status
**Contents**
.. image:: https://codecov.io/gh/vkbo/novelWriter/branch/master/graph/badge.svg
:target: https://codecov.io/gh/vkbo/novelWriter
:alt: Code Coverage
.. image:: https://readthedocs.org/projects/novelwriter/badge/?version=latest
:target: https://novelwriter.readthedocs.io/en/latest/?badge=latest
:alt: Documentation
.. image:: https://img.shields.io/github/v/release/vkbo/novelwriter
:target: https://github.com/vkbo/novelWriter/releases
:alt: GitHub Release
.. image:: https://img.shields.io/pypi/v/novelwriter
:target: https://pypi.org/project/novelWriter/
:alt: PyPI
.. image:: https://img.shields.io/pypi/pyversions/novelwriter
:target: https://pypi.org/project/novelWriter/
:alt: Python Version
novelWriter is a markdown-like text editor designed for writing novels and larger projects of many
smaller plain text documents. It uses its own flavour of markdown that supports a meta data syntax
for comments, synopsis and cross-referencing between files. The idea is to have a simple text editor
which allows for easy organisation of text files and notes, built on a plain text file project
repository for robustness.
The plain text storage is suitable for version control software, and also well suited for file
synchronisation tools. The core project structure is stored in a project XML file. Other meta data
is primarily saved in JSON files.
Useful Links
============
* 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
* PyPi Project: https://pypi.org/project/novelWriter
Contents
========
.. toctree::
:maxdepth: 2
@@ -18,7 +63,9 @@ This is the documentation for novelWriter |release|.
export
technical
**Indices and Tables**
Indices and Tables
==================
* :ref:`genindex`
* :ref:`modindex`