You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
George Sokianos 789004ea2c Updates and fixes for the latest available code, for 2.1 release 2 months ago
.github gh workflow: don't make release on tag pushes to prevent double release when executed from github web interface. 2 months ago
data Updates and fixes for the latest available code, for 2.1 release 2 months ago
docs docs: documented ARCH global. 2 months ago
licenses Fix Project Scanning (#746) 9 months ago
resources lua patch for utf-8 support 6 months ago
scripts innosetup changes 2 months ago
src Updates and fixes for the latest available code, for 2.1 release 2 months ago
subprojects updated sdl2 wrap to 2.24 3 months ago
.editorconfig Updated Meson configuration 1 year ago
.gitattributes Merge pull request #309 from redtide/git-line-endings 1 year ago
.gitignore Merge branch 'master' into amiga-2.0 2 months ago
LICENSE Added Release Workflow and Fixed some build script issues (#1013) 2 months ago
Makefile.mos Updates and fixes for the latest available code, for 2.1 release 2 months ago
Makefile.os4 Updates and fixes for the latest available code, for 2.1 release 2 months ago
README.md Fix [build] link and add [lite] link on Overview (#1096) 4 months ago
README_Amiga.md Updates and fixes for the latest available code, for 2.1 release 2 months ago
README_Amiga.md.info Merged MOS and OS4 code. Did some more fixes before the 2.0.3r2 release. 5 months ago
build-packages.sh Added Release Workflow and Fixed some build script issues (#1013) 2 months ago
build.lhelper Adapt build job to lhelper-2 5 months ago
changelog.md updated changelog 2 months ago
meson.build updated sdl2 wrap to 2.24 3 months ago
meson_options.txt seperate dirmonitor logic, add build time detection of features (#866) 9 months ago

README.md

Lite XL

CI Discord Badge Image

screenshot-dark

A lightweight text editor written in Lua, adapted from lite.

Please refer to our website for the user and developer documentation, including build instructions details. A quick build guide is described below.

Lite XL has support for high DPI display on Windows and Linux and, since 1.16.7 release, it supports retina displays on macOS.

Please note that Lite XL is compatible with lite for most plugins and all color themes. We provide a separate lite-xl-plugins repository for Lite XL, because in some cases some adaptations may be needed to make them work better with Lite XL. The repository with modified plugins is https://github.com/lite-xl/lite-xl-plugins.

The changes and differences between Lite XL and rxi/lite are listed in the changelog.

Overview

Lite XL is derived from lite. It is a lightweight text editor written mostly in Lua — it aims to provide something practical, pretty, small and fast easy to modify and extend, or to use without doing either.

The aim of Lite XL compared to lite is to be more user friendly, improve the quality of font rendering, and reduce CPU usage.

Customization

Additional functionality can be added through plugins which are available in the plugins repository or in the Lite XL plugins repository.

Additional color themes can be found in the colors repository. These color themes are bundled with all releases of Lite XL by default.

Quick Build Guide

If you compile Lite XL yourself, it is recommended to use the script build-packages.sh:

bash build-packages.sh -h

The script will run Meson and create a tar compressed archive with the application or, for Windows, a zip file. Lite XL can be easily installed by unpacking the archive in any directory of your choice.

Otherwise the following is an example of basic commands if you want to customize the build:

meson setup --buildtype=release --prefix <prefix> build
meson compile -C build
DESTDIR="$(pwd)/lite-xl" meson install --skip-subprojects -C build

where <prefix> might be one of /, /usr or /opt, the default is /. To build a bundle application on macOS:

meson setup --buildtype=release --Dbundle=true --prefix / build
meson compile -C build
DESTDIR="$(pwd)/Lite XL.app" meson install --skip-subprojects -C build

Please note that the package is relocatable to any prefix and the option prefix affects only the place where the application is actually installed.

Installing Prebuilt

Head over to releases and download the version for your operating system.

Linux

Unzip the file and cd into the lite-xl directory:

tar -xzf <file>
cd lite-xl

To run lite-xl without installing:

cd bin
./lite-xl

To install lite-xl copy files over into appropriate directories:

mkdir -p $HOME/.local/bin && cp bin/lite-xl $HOME/.local/bin
cp -r share $HOME/.local

If $HOME/.local/bin is not in PATH:

echo -e 'export PATH=$PATH:$HOME/.local/bin' >> $HOME/.bashrc

To get the icon to show up in app launcher:

xdg-desktop-menu forceupdate

You may need to logout and login again to see icon in app launcher.

To uninstall just run:

rm -f $HOME/.local/bin/lite-xl
rm -rf $HOME/.local/share/icons/hicolor/scalable/apps/lite-xl.svg \
          $HOME/.local/share/applications/org.lite_xl.lite_xl.desktop \
          $HOME/.local/share/metainfo/org.lite_xl.lite_xl.appdata.xml \
          $HOME/.local/share/lite-xl

Contributing

Any additional functionality that can be added through a plugin should be done as a plugin, after which a pull request to the Lite XL plugins repository can be made.

Pull requests to improve or modify the editor itself are welcome.

Licenses

This project is free software; you can redistribute it and/or modify it under the terms of the MIT license. See LICENSE for details.

See the licenses file for details on licenses used by the required dependencies.