Twilight 项目技术文档

Twilight 项目技术文档

twilight.nvim 🌅 Twilight is a Lua plugin for Neovim 0.5 that dims inactive portions of the code you're editing using TreeSitter. 项目地址: https://gitcode.com/gh_mirrors/tw/twilight.nvim

1. 安装指南

环境要求

• Neovim >= 0.5.0

安装步骤

使用你喜欢的包管理器安装 Twilight 插件：

使用 lazy.nvim 安装

-- Lua
{
  "folke/twilight.nvim",
  opts = {
    -- 你的配置在这里
    -- 或者留空以使用默认设置
    -- 参考下面的配置部分
  }
}

2. 项目使用说明

手动触发 Twilight

你可以使用以下命令手动触发 Twilight：

• Twilight: 切换 Twilight 状态
• TwilightEnable: 启用 Twilight
• TwilightDisable: 禁用 Twilight

Zen Mode 集成

如果你安装了 zen-mode，Twilight 会自动激活。你可以参考 Zen Mode 的文档来禁用此功能。

3. 项目 API 使用文档

默认配置

Twilight 提供了以下默认配置：

{
  dimming = {
    alpha = 0.25, -- 暗淡程度
    color = { "Normal", "#ffffff" }, -- 前景色
    term_bg = "#000000", -- 如果 guibg=NONE，将使用此颜色计算文本颜色
    inactive = false, -- 当为 true 时，其他窗口将完全暗淡（除非它们包含相同的缓冲区）
  },
  context = 10, -- 当前行周围的行数
  treesitter = true, -- 使用 treesitter（如果可用）
  expand = { -- 对于 treesitter，我们总是尝试扩展到这些类型的最顶层祖先
    "function",
    "method",
    "table",
    "if_statement",
  },
  exclude = {}, -- 排除这些文件类型
}

配置说明

• dimming.alpha: 控制暗淡的程度，范围为 0 到 1。
• dimming.color: 前景色，可以从高亮组或备用颜色中获取。
• dimming.term_bg: 如果 guibg=NONE，将使用此颜色计算文本颜色。
• dimming.inactive: 控制其他窗口是否完全暗淡。
• context: 当前行周围的行数。
• treesitter: 是否使用 treesitter。
• expand: 控制 treesitter 扩展的节点类型。
• exclude: 排除的文件类型。

4. 项目安装方式

使用 lazy.nvim 安装

-- Lua
{
  "folke/twilight.nvim",
  opts = {
    -- 你的配置在这里
    -- 或者留空以使用默认设置
    -- 参考下面的配置部分
  }
}

通过以上步骤，你可以成功安装并配置 Twilight 插件，享受更专注的代码编辑体验。

twilight.nvim 🌅 Twilight is a Lua plugin for Neovim 0.5 that dims inactive portions of the code you're editing using TreeSitter. 项目地址: https://gitcode.com/gh_mirrors/tw/twilight.nvim