True-Zen.nvim 项目教程

True-Zen.nvim 项目教程

true-zen.nvim🦝 Clean and elegant distraction-free writing for NeoVim项目地址:https://gitcode.com/gh_mirrors/tr/true-zen.nvim

1. 项目的目录结构及介绍

True-Zen.nvim 是一个用于 NeoVim 的插件，旨在提供一个干净、优雅的无干扰写作环境。以下是项目的目录结构及其介绍：

true-zen.nvim/
├── lua/
│   └── true-zen/
│       ├── init.lua
│       ├── ataraxis.lua
│       ├── minimalist.lua
│       ├── narrow.lua
│       └── focus.lua
├── plugin/
│   └── true-zen.lua
├── editorconfig
├── gitignore
├── LICENSE
├── Makefile
├── README.md
└── stylua.toml

• lua/: 包含插件的主要逻辑和功能模块。
  • true-zen/: 包含各个模式的实现文件。
    • init.lua: 插件的初始化文件。
    • ataraxis.lua: Ataraxis 模式的实现。
    • minimalist.lua: Minimalist 模式的实现。
    • narrow.lua: Narrow 模式的实现。
    • focus.lua: Focus 模式的实现。
• plugin/: 包含插件的加载文件。
  • true-zen.lua: 插件的加载脚本。
• editorconfig: 编辑器配置文件。
• gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• Makefile: 项目构建文件。
• README.md: 项目说明文档。
• stylua.toml: 代码格式化配置文件。

2. 项目的启动文件介绍

项目的启动文件是 lua/true-zen/init.lua。这个文件负责初始化插件并加载各个模式的功能。以下是 init.lua 的主要内容：

-- 初始化插件
require('true-zen').setup({
  -- 配置选项
})

3. 项目的配置文件介绍

项目的配置文件是 lua/true-zen/init.lua 中的 setup 函数调用。你可以在这里配置插件的各种选项。以下是一个示例配置：

require('true-zen').setup({
  ataraxis = {
    enabled = false,
    font = "+3",
    twilight = false,
    lualine = false,
  },
  minimalist = {
    enabled = true,
  },
  narrow = {
    enabled = true,
  },
  focus = {
    enabled = true,
  },
})

• ataraxis: 配置 Ataraxis 模式。
  • enabled: 是否启用 Ataraxis 模式。
  • font: 字体大小。
  • twilight: 是否启用 Twilight 模式。
  • lualine: 是否隐藏状态栏。
• minimalist: 配置 Minimalist 模式。
  • enabled: 是否启用 Minimalist 模式。
• narrow: 配置 Narrow 模式。
  • enabled: 是否启用 Narrow 模式。
• focus: 配置 Focus 模式。
  • enabled: 是否启用 Focus 模式。

通过这些配置，你可以根据需要自定义 True-Zen.nvim 插件的行为。

true-zen.nvim🦝 Clean and elegant distraction-free writing for NeoVim项目地址:https://gitcode.com/gh_mirrors/tr/true-zen.nvim