lite-xl

机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

Lite XL

![Discord 徽章图片]

一个用 Lua 编写的轻量级文本编辑器，改编自 lite。

• [获取 Lite XL] — 适用于 Windows、Linux 和 Mac OS 的下载。
• [获取插件] — 添加额外功能，适用于 Lite XL。
• [获取颜色主题] — 添加额外的颜色主题。

请参阅我们的 [网站] 了解用户和开发者文档，包括 [构建] 说明的详细信息。下面介绍了一个快速构建指南。

Lite XL 支持 Windows 和 Linux 上的高 DPI 显示，自 1.16.7 版本起，它支持 macOS 的 Retina 显示屏。

请注意，Lite XL 与 lite 对大多数插件和所有颜色主题都是兼容的。我们为 Lite XL 提供了一个单独的 lite-xl-plugins 仓库，因为在某些情况下，可能需要进行一些适配，使其在 Lite XL 上运行得更好。修改后的插件仓库是 https://github.com/lite-xl/lite-xl-plugins。

Lite XL 与 rxi/lite 之间的更改和差异在 [更新日志] 中列出。

概览

Lite XL 源自 lite。它是一款主要用 Lua 编写的轻量级文本编辑器——它的目标是提供一种实用、美观、小巧 且快速、易于修改和扩展，或者无需进行任何修改和扩展即可使用的编辑器。

与 lite 相比，Lite XL 的目标是更加用户友好，提升字体渲染质量，并减少 CPU 使用率。

自定义

可以通过插件添加额外功能，这些插件可以在[插件仓库]或[Lite XL 插件仓库]中找到。

可以在[颜色仓库]中找到额外的配色主题。这些配色主题默认随所有版本的 Lite XL 一起捆绑提供。

快速构建指南

要自己编译 Lite XL，您必须通过您选择的软件包管理器安装以下依赖项，或者手动安装。

先决条件

• 介子 (>=0.63)
• 忍者
• SDL2
• PCRE2
• FreeType2
• Lua 5.4
• 一个可用的 C 编译器 (GCC / Clang / MSVC)

如果指定了 --wrap-mode=forcefallback 或 --wrap-mode=default，Meson 将下载 SDL2、PCRE2、FreeType2 和 Lua。

在 Linux 上，您可以安装以下依赖项以使 SDL2 X11 和/或 Wayland 后端正常工作：

• libX11-devel
• libXi-devel
• libXcursor-devel
• libxkbcommon-devel
• libXrandr-devel
• wayland-devel
• wayland-protocols-devel
• dbus-devel
• ibus-devel

以下命令可用于在 Ubuntu 中安装这些依赖项：

apt-get install python3.8 python3-pip build-essential git cmake wayland-protocols libsdl2-dev
pip3 install meson ninja

请参阅 lite-xl-build-box，以获取用于打包官方 Lite XL 版本的可用 Linux 构建环境。

在 macOS 上，您必须通过 Brew 安装 bash，因为 macOS 上的默认 bash 版本过时，可能无法正确运行构建脚本。

构建

您可以使用 scripts/build.sh 来设置 Lite XL 并进行构建。

$ bash build.sh --help
# Usage: scripts/build.sh <OPTIONS>
# 
# Available options:
# 
# -b --builddir DIRNAME         Sets the name of the build directory (not path).
#                               Default: 'build-x86_64-linux'.
#    --debug                    Debug this script.
# -f --forcefallback            Force to build dependencies statically.
# -h --help                     Show this help and exit.
# -d --debug-build              Builds a debug build.
# -p --prefix PREFIX            Install directory prefix. Default: '/'.
# -B --bundle                   Create an App bundle (macOS only)
# -A --addons                   Add in addons
# -P --portable                 Create a portable binary package.
# -r --reconfigure              Tries to reuse the meson build directory, if possible.
#                               Default: Deletes the build directory and recreates it.
# -O --pgo                      Use profile guided optimizations (pgo).
#                               macOS: disabled when used with --bundle,
#                               Windows: Implicit being the only option.
#    --cross-platform PLATFORM  Cross compile for this platform.
#                               The script will find the appropriate
#                               cross file in 'resources/cross'.
#    --cross-arch ARCH          Cross compile for this architecture.
#                               The script will find the appropriate
#                               cross file in 'resources/cross'.
#    --cross-file CROSS_FILE    Cross compile with the given cross file.

或者，您可以使用以下命令来自定义构建：

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

其中 <prefix> 可能是 /、/usr 或 /opt，默认是 /。在 macOS 上构建捆绑应用程序：

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

请注意，该软件包可以迁移到任何前缀，并且选项 prefix 只影响应用程序实际安装的位置。

安装预构建版本

前往 releases 并下载适用于您操作系统的版本。

预编译版本支持以下操作系统：

• Windows 7 及更高版本
• Ubuntu 18.04 及更高版本（glibc 2.27 及更高版本）
• OS X El Capitan 及更高版本（版本 10.11 及更高版本）

某些发行版可能会为它们的平台提供自定义二进制文件。

Windows

Lite XL 在 Windows 上提供典型安装的安装程序。或者，我们也提供可以下载后解压到任意位置并直接运行的 ZIP 压缩包。

要使 Lite XL 便携（例如从 U 盘运行 Lite XL），只需在 lite-xl.exe 所在位置创建一个 user 文件夹。Lite XL 将在该文件夹中加载并存储您的所有配置和插件。

macOS

我们为 macOS 提供 DMG 文件。只需将程序拖到您的应用程序文件夹即可。

重要
较新的 Lite XL 版本使用自签名证书进行签名，因此首次运行 Lite XL 时，您需要按照这些步骤操作。

1. 在 Finder 中找到 Lite XL（不要在 Launchpad 中打开它）。
2. 按住 Control 键点击 Lite XL，然后从快捷菜单中选择 Open。
3. 在弹出菜单中点击 Open。

正确的步骤可能因 macOS 版本而异，因此你应该参考
the macOS User Guide.

在旧版本的 Lite XL 上，您需要改为运行这些命令：

# 清除目录上的属性 xattr -cr /Applications/Lite\ XL.app

否则，macOS 会显示一个非常误导性的错误，说应用程序已损坏。

Linux

解压文件并将 cd 放入 lite-xl 目录：

tar -xzf <file>
cd lite-xl

在不安装的情况下运行 lite-xl：

./lite-xl

要安装 lite-xl，请将文件复制到相应的目录中：

rm -rf  $HOME/.local/share/lite-xl $HOME/.local/bin/lite-xl
mkdir -p $HOME/.local/bin && cp lite-xl $HOME/.local/bin/
mkdir -p $HOME/.local/share/lite-xl && cp -r data/* $HOME/.local/share/lite-xl/

将 Lite XL 添加到 PATH

要从命令行运行 Lite XL，您必须将其添加到 PATH。

如果 $HOME/.local/bin 不在 PATH 中：

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

或者在最近版本的 GNOME 和 KDE Plasma 上，你可以通过 ~/.config/environment.d/envvars.conf 将 $HOME/.local/bin 添加到 PATH：

PATH=$HOME/.local/bin:$PATH

注意
某些系统在登录时可能无法加载 .bashrc。
这可能会导致从桌面/菜单启动应用程序时出现问题。

将 Lite XL 添加到应用程序启动器

要让图标出现在应用程序启动器中，你需要创建一个桌面条目并将其放入 /usr/share/applications 或 ~/.local/share/applications。

以下是在 ~/.local/share/applications/com.lite_xl.LiteXL.desktop 中创建桌面条目的示例，假设 Lite XL 已在 PATH 中：

[Desktop Entry]
Type=Application
Name=Lite XL
Comment=A lightweight text editor written in Lua
Exec=lite-xl %F
Icon=lite-xl
Terminal=false
StartupWMClass=lite-xl
Categories=Development;IDE;
MimeType=text/plain;inode/directory;

要立即在应用启动器中显示图标，请运行：

xdg-desktop-menu forceupdate

或者，您可以注销后重新登录。

卸载

要卸载 Lite XL，请运行：

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

贡献

任何可以通过插件添加的额外功能都应该作为插件添加，然后可以向 [Lite XL 插件仓库] 提交拉取请求。

欢迎提交拉取请求以改进或修改编辑器本身。更多细节请参见 CONTRIBUTING.md。

许可证

这个项目是自由软件；你可以根据 MIT 许可证的条款重新分发和/或修改它。详细信息请参见 LICENSE。

有关所需依赖项使用的许可证的详细信息，请参见 licenses 文件。