{"id":13409163,"url":"https://github.com/lite-xl/lite-xl","last_synced_at":"2025-05-13T17:04:49.243Z","repository":{"id":36990786,"uuid":"266620119","full_name":"lite-xl/lite-xl","owner":"lite-xl","description":"A lightweight text editor written in Lua","archived":false,"fork":false,"pushed_at":"2025-05-06T05:10:13.000Z","size":17067,"stargazers_count":5249,"open_issues_count":269,"forks_count":248,"subscribers_count":54,"default_branch":"master","last_synced_at":"2025-05-06T06:23:52.981Z","etag":null,"topics":["c","code","editor","lite-xl","lua","sdl2"],"latest_commit_sha":null,"homepage":"https://lite-xl.com","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lite-xl.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"franko"}},"created_at":"2020-05-24T20:32:25.000Z","updated_at":"2025-05-06T05:07:02.000Z","dependencies_parsed_at":"2023-10-23T22:36:12.569Z","dependency_job_id":"2f11b23e-fedc-4a47-ab48-cdb76f661a34","html_url":"https://github.com/lite-xl/lite-xl","commit_stats":null,"previous_names":[],"tags_count":80,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lite-xl%2Flite-xl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lite-xl%2Flite-xl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lite-xl%2Flite-xl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lite-xl%2Flite-xl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lite-xl","download_url":"https://codeload.github.com/lite-xl/lite-xl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253990460,"owners_count":21995774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","code","editor","lite-xl","lua","sdl2"],"created_at":"2024-07-30T20:00:58.475Z","updated_at":"2025-05-13T17:04:49.231Z","avatar_url":"https://github.com/lite-xl.png","language":"Lua","funding_links":["https://github.com/sponsors/franko"],"categories":["Graphical-based editors","Lua","Text Editors","编辑器","Table of Contents"],"sub_categories":["资源传输下载","Text Editor"],"readme":"# Lite XL\n\n[![CI]](https://github.com/lite-xl/lite-xl/actions/workflows/build.yml)\n[![Discord Badge Image]](https://discord.gg/UQKnzBhY5H)\n\n![screenshot-dark]\n\nA lightweight text editor written in Lua, adapted from [lite].\n\n* **[Get Lite XL]** — Download for Windows, Linux and Mac OS.\n* **[Get plugins]** — Add additional functionality, adapted for Lite XL.\n* **[Get color themes]** — Add additional colors themes.\n\nPlease refer to our [website] for the user and developer documentation,\nincluding [build] instructions details. A quick build guide is described below.\n\nLite XL has support for high DPI display on Windows and Linux and,\nsince 1.16.7 release, it supports **retina displays** on macOS.\n\nPlease note that Lite XL is compatible with lite for most plugins and all color themes.\nWe provide a separate lite-xl-plugins repository for Lite XL, because in some cases\nsome adaptations may be needed to make them work better with Lite XL.\nThe repository with modified plugins is https://github.com/lite-xl/lite-xl-plugins.\n\nThe changes and differences between Lite XL and rxi/lite are listed in the\n[changelog].\n\n## Overview\n\nLite XL is derived from [lite].\nIt is a lightweight text editor written mostly in Lua — it aims to provide\nsomething practical, pretty, *small* and fast easy to modify and extend,\nor to use without doing either.\n\nThe aim of Lite XL compared to lite is to be more user friendly,\nimprove the quality of font rendering, and reduce CPU usage.\n\n## Customization\n\nAdditional functionality can be added through plugins which are available in\nthe [plugins repository] or in the [Lite XL plugins repository].\n\nAdditional color themes can be found in the [colors repository].\nThese color themes are bundled with all releases of Lite XL by default.\n\n## Quick Build Guide\n\nTo compile Lite XL yourself, you must have the following dependencies installed\nvia your desired package manager, or manually.\n\n### Prerequisites\n\n- Meson (\u003e=0.63)\n- Ninja\n- SDL2\n- PCRE2\n- FreeType2\n- Lua 5.4\n- A working C compiler (GCC / Clang / MSVC)\n\nSDL2, PCRE2, FreeType2 and Lua will be downloaded by Meson\nif `--wrap-mode=forcefallback` or `--wrap-mode=default` is specified.\n\n\u003e [!NOTE]\n\u003e MSVC is used in the CI, but MSVC-compiled binaries are not distributed officially\n\u003e or tested extensively for bugs.\n\nOn Linux, you may install the following dependencies for the SDL2 X11 and/or Wayland backend to work properly:\n\n- `libX11-devel`\n- `libXi-devel`\n- `libXcursor-devel`\n- `libxkbcommon-devel`\n- `libXrandr-devel`\n- `wayland-devel`\n- `wayland-protocols-devel`\n- `dbus-devel`\n- `ibus-devel`\n\nThe following command can be used to install the dependencies in Ubuntu:\n\n```sh\napt-get install python3.8 python3-pip build-essential git cmake wayland-protocols libsdl2-dev\npip3 install meson ninja\n```\n\nPlease refer to [lite-xl-build-box] for a working Linux build environment used to package official Lite XL releases.\n\nOn macOS, you must install bash via Brew, as the default bash version on macOS is antiquated\nand may not run the build script correctly.\n\n### Building\n\nYou can use `scripts/build.sh` to set up Lite XL and build it.\n\n```sh\n$ bash build.sh --help\n# Usage: scripts/build.sh \u003cOPTIONS\u003e\n# \n# Available options:\n# \n# -b --builddir DIRNAME         Sets the name of the build directory (not path).\n#                               Default: 'build-x86_64-linux'.\n#    --debug                    Debug this script.\n# -f --forcefallback            Force to build dependencies statically.\n# -h --help                     Show this help and exit.\n# -d --debug-build              Builds a debug build.\n# -p --prefix PREFIX            Install directory prefix. Default: '/'.\n# -B --bundle                   Create an App bundle (macOS only)\n# -A --addons                   Add in addons\n# -P --portable                 Create a portable binary package.\n# -r --reconfigure              Tries to reuse the meson build directory, if possible.\n#                               Default: Deletes the build directory and recreates it.\n# -O --pgo                      Use profile guided optimizations (pgo).\n#                               macOS: disabled when used with --bundle,\n#                               Windows: Implicit being the only option.\n#    --cross-platform PLATFORM  Cross compile for this platform.\n#                               The script will find the appropriate\n#                               cross file in 'resources/cross'.\n#    --cross-arch ARCH          Cross compile for this architecture.\n#                               The script will find the appropriate\n#                               cross file in 'resources/cross'.\n#    --cross-file CROSS_FILE    Cross compile with the given cross file.\n```\n\nAlternatively, you can use the following commands to customize the build:\n\n```sh\nmeson setup --buildtype=release --prefix \u003cprefix\u003e build\nmeson compile -C build\nDESTDIR=\"$(pwd)/lite-xl\" meson install --skip-subprojects -C build\n```\n\nwhere `\u003cprefix\u003e` might be one of `/`, `/usr` or `/opt`, the default is `/`.\nTo build a bundle application on macOS:\n\n```sh\nmeson setup --buildtype=release --Dbundle=true --prefix / build\nmeson compile -C build\nDESTDIR=\"$(pwd)/Lite XL.app\" meson install --skip-subprojects -C build\n```\n\nPlease note that the package is relocatable to any prefix and the option prefix\naffects only the place where the application is actually installed.\n\n## Installing Prebuilt\n\nHead over to [releases](https://github.com/lite-xl/lite-xl/releases) and download the version for your operating system.\n\nThe prebuilt releases supports the following OSes:\n\n- Windows 7 and above\n- Ubuntu 18.04 and above (glibc 2.27 and above)\n- OS X El Capitan and above (version 10.11 and above)\n\nSome distributions may provide custom binaries for their platforms.\n\n### Windows\n\nLite XL comes with installers on Windows for typical installations.\nAlternatively, we provide ZIP archives that you can download and extract anywhere and run directly.\n\nTo make Lite XL portable (e.g. running Lite XL from a thumb drive),\nsimply create a `user` folder where `lite-xl.exe` is located.\nLite XL will load and store all your configurations and plugins in the folder.\n\n### macOS\n\nWe provide DMG files for macOS. Simply drag the program into your Applications folder.\n\n\u003e **Important**\n\u003e Newer versions of Lite XL are signed with a self-signed certificate,\n\u003e so you'll have to follow these steps when running Lite XL for the first time.\n\u003e\n\u003e 1. Find Lite XL in Finder (do not open it in Launchpad).\n\u003e 2. Control-click Lite XL, then choose `Open` from the shortcut menu.\n\u003e 3. Click `Open` in the popup menu.\n\u003e\n\u003e The correct steps may vary between macOS versions, so you should refer to\n\u003e the [macOS User Guide](https://support.apple.com/en-my/guide/mac-help/mh40616/mac).\n\u003e\n\u003e On an older version of Lite XL, you will need to run these commands instead:\n\u003e \n\u003e ```sh\n\u003e # clears attributes from the directory\n\u003e xattr -cr /Applications/Lite\\ XL.app\n\u003e ```\n\u003e\n\u003e Otherwise, macOS will display a **very misleading error** saying that the application is damaged.\n\n### Linux\n\nUnzip the file and `cd` into the `lite-xl` directory:\n\n```sh\ntar -xzf \u003cfile\u003e\ncd lite-xl\n```\n\nTo run lite-xl without installing:\n\n```sh\n./lite-xl\n```\n\nTo install lite-xl copy files over into appropriate directories:\n\n```sh\nrm -rf  $HOME/.local/share/lite-xl $HOME/.local/bin/lite-xl\nmkdir -p $HOME/.local/bin \u0026\u0026 cp lite-xl $HOME/.local/bin/\nmkdir -p $HOME/.local/share/lite-xl \u0026\u0026 cp -r data/* $HOME/.local/share/lite-xl/\n```\n\n#### Add Lite XL to PATH\n\nTo run Lite XL from the command line, you must add it to PATH.\n\nIf `$HOME/.local/bin` is not in PATH:\n\n```sh\necho -e 'export PATH=$PATH:$HOME/.local/bin' \u003e\u003e $HOME/.bashrc\n```\n\nAlternatively on recent versions of GNOME and KDE Plasma,\nyou can add `$HOME/.local/bin` to PATH via `~/.config/environment.d/envvars.conf`:\n\n```ini\nPATH=$HOME/.local/bin:$PATH\n```\n\n\u003e **Note**\n\u003e Some systems might not load `.bashrc` when logging in.\n\u003e This can cause problems with launching applications from the desktop / menu.\n\n#### Add Lite XL to application launchers\n\nTo get the icon to show up in app launcher, you need to create a desktop\nentry and put it into `/usr/share/applications` or `~/.local/share/applications`.\n\nHere is an example for a desktop entry in `~/.local/share/applications/com.lite_xl.LiteXL.desktop`,\nassuming Lite XL is in PATH:\n\n```ini\n[Desktop Entry]\nType=Application\nName=Lite XL\nComment=A lightweight text editor written in Lua\nExec=lite-xl %F\nIcon=lite-xl\nTerminal=false\nStartupWMClass=lite-xl\nCategories=Development;IDE;\nMimeType=text/plain;inode/directory;\n```\n\nTo get the icon to show up in app launcher immediately, run:\n\n```sh\nxdg-desktop-menu forceupdate\n```\n\nAlternatively, you may log out and log in again.\n\n#### Uninstall\n\nTo uninstall Lite XL, run:\n\n```sh\nrm -f $HOME/.local/bin/lite-xl\nrm -rf $HOME/.local/share/icons/hicolor/scalable/apps/lite-xl.svg \\\n          $HOME/.local/share/applications/com.lite_xl.LiteXL.desktop \\\n          $HOME/.local/share/metainfo/com.lite_xl.LiteXL.appdata.xml \\\n          $HOME/.local/share/lite-xl\n```\n\n## Contributing\n\nAny additional functionality that can be added through a plugin should be done\nas a plugin, after which a pull request to the [Lite XL plugins repository] can be made.\n\nPull requests to improve or modify the editor itself are welcome.\n\n## Licenses\n\nThis project is free software; you can redistribute it and/or modify it under\nthe terms of the MIT license. See [LICENSE] for details.\n\nSee the [licenses] file for details on licenses used by the required dependencies.\n\n\n[CI]:                         https://github.com/lite-xl/lite-xl/actions/workflows/build.yml/badge.svg\n[Discord Badge Image]:        https://img.shields.io/discord/847122429742809208?label=discord\u0026logo=discord\n[screenshot-dark]:            https://user-images.githubusercontent.com/433545/111063905-66943980-84b1-11eb-9040-3876f1133b20.png\n[lite]:                       https://github.com/rxi/lite\n[website]:                    https://lite-xl.com\n[build]:                      https://lite-xl.com/setup/building-from-source/\n[Get Lite XL]:                https://github.com/lite-xl/lite-xl/releases/latest\n[Get plugins]:                https://github.com/lite-xl/lite-xl-plugins\n[Get color themes]:           https://github.com/lite-xl/lite-xl-colors\n[changelog]:                  https://github.com/lite-xl/lite-xl/blob/master/changelog.md\n[Lite XL plugins repository]: https://github.com/lite-xl/lite-xl-plugins\n[plugins repository]:         https://github.com/rxi/lite-plugins\n[colors repository]:          https://github.com/lite-xl/lite-xl-colors\n[LICENSE]:                    LICENSE\n[licenses]:                   licenses/licenses.md\n[lite-xl-build-box]:          https://github.com/lite-xl/lite-xl-build-box\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flite-xl%2Flite-xl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flite-xl%2Flite-xl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flite-xl%2Flite-xl/lists"}