开源项目 dimmer.el 使用教程
1. 项目的目录结构及介绍
dimmer.el/
├── dimmer.el
├── README.md
├── LICENSE
└── test
└── dimmer-test.el
- dimmer.el: 项目的主文件,包含了所有的核心功能和逻辑。
- README.md: 项目的说明文档,介绍了项目的基本信息和使用方法。
- LICENSE: 项目的许可证文件,说明项目的授权和使用条款。
- test/dimmer-test.el: 项目的测试文件,用于测试核心功能的正确性。
2. 项目的启动文件介绍
项目的启动文件是 dimmer.el
。该文件包含了项目的核心功能和逻辑,主要用于在 Emacs 中实现缓冲区的视觉高亮。以下是启动文件的主要内容:
(require 'dimmer)
(dimmer-configure-which-key)
(dimmer-configure-helm)
(dimmer-mode t)
- (require 'dimmer): 加载
dimmer.el
文件。 - (dimmer-configure-which-key): 配置 which-key 插件,确保 which-key 弹出窗口不被调暗。
- (dimmer-configure-helm): 配置 helm 插件。
- (dimmer-mode t): 启用 dimmer 模式。
3. 项目的配置文件介绍
项目的配置文件主要是 dimmer.el
文件中的自定义选项。以下是一些主要的配置选项:
- dimmer-adjustment-mode: 控制调暗时调整的颜色方案的方面,可选值为
:foreground
(默认)、:background
或:both
。 - dimmer-fraction: 控制缓冲区调暗的程度,范围是 0.0 - 1.0,默认值为 0.20。增加该值可以使其他缓冲区更暗。
- dimmer-buffer-exclusion-regexps: 用于指定永不调暗的缓冲区,如果缓冲区名称匹配该列表中的任何正则表达式,则不会调暗该缓冲区。
- dimmer-buffer-exclusion-predicates: 用于指定永不调暗的缓冲区,如果缓冲区名称匹配该列表中的任何谓词,则不会调暗该缓冲区。
示例配置:
(setq dimmer-adjustment-mode :foreground)
(setq dimmer-fraction 0.30)
(setq dimmer-buffer-exclusion-regexps '("^ \\*helm\\*" "^ \\*Messages\\*"))
以上配置将调整前景色,将调暗程度增加到 0.30,并排除 *helm*
和 *Messages*
缓冲区。