https://github.com/adamharrison/write-xl

A set of plugins for Lite XL that make the editor appropriate for creative writing.
https://github.com/adamharrison/write-xl

Last synced: 1 day ago
JSON representation

A set of plugins for Lite XL that make the editor appropriate for creative writing.

• Host: GitHub
• URL: https://github.com/adamharrison/write-xl
• Owner: adamharrison
• Created: 2021-11-23T20:17:26.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-04T14:16:45.000Z (over 1 year ago)
• Last Synced: 2023-07-04T15:27:57.717Z (over 1 year ago)
• Language: C++
• Size: 6.98 MB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# write-xl

`write-xl` is a set of plugins that operates overtop of lite-xl. It's designed to make the text editor more appealing to use for writing and reading fiction, in markdown.

## Features

* A more word-like **color** scheme.

* An automatic configuration of line wrapping and document setup to be more word-like.

* Keybinds for standard stuff like bolding, italicizing, and underlining (`ctrl`+`b`, `ctrl`+`i`, `ctrl`+`u`).

* Spellchecker

* Synonyms

* Jump to Chapter

* Ability use git quicly and easily to track changes, and to provide a method of remote synchroniation.

* Word Counter

* Small clock in the bottom right corner.

* Small clock that tracks current session time.

* Small clock that tracks actual writing time.

* Autocorrect plugin that corrects-as-you-type to a preset list of words, or to a dictionary.

## TODO

* Chapter Navigation, via sidebar.

* Chapter wordcount in parentheses on sidebar.

* Automatic Chapter Summaries as a view, by running chapter through an automatic summarizer library.

* Side-by-Side Outline Reading

* A plugin to detect whether you're overusing a particular phrase.

* Character Registry, with Minimap

* Ability to have a view of a chapter as an individual document (`ChapterView`, inherited from DocView).

## Install

To install, simply use [`lpm`](https://github.com/lite-xl/lite-xl-plugin-manager):

```

lpm install write-xl

```

Or, alternatively, simply copy the plugins in the `plugins` folder, and the colors from the `colors` folder into your local copies of both, and install a few extra plugins from lite-xl-plugins.

Or, you can simply pull an all-in-one-release from the [releases](https://github.com/adamharrison/write-xl/releases) page.

### Releases

The non-mobile releases for `write-xl` are pre-built with [`lite-xl-simplified`](https://github.com/adamharrison/lite-xl-simplified)'s all-in-one mode, meaning that it will be created as a single executable,

that uses `~/.config/write-xl` as its user directory, with the `write-xl` plugin installed.

The mobile releases for `write-xl` are built with [`lite-xl-android`](https://github.com/adamharrison/lite-xl-android), for `x86`, `x86_64`, `arm64` and `armv7`, and should function out of the box on most

android phones.