de 编辑器使用教程

de 编辑器使用教程

de A Programmer's Text Editor 项目地址: https://gitcode.com/gh_mirrors/de/de

1. 项目目录结构及介绍

de/
├── actions/
├── demodel/
├── deplumber/
├── kbmap/
├── plugins/
├── position/
├── renderer/
├── scripts/
├── vendor/9fans.net/go/
├── viewer/
├── .gitignore
├── .travis.yml
├── COMMANDS.md
├── CONTRIBUTING.md
├── LICENSE
├── PLUGINS.md
├── PLUMBING.md
├── README.md
├── USAGE.md
├── main.go
├── plugins.go
├── plumber.go
├── plumber_plan9.go
└── window.go

目录结构说明

• actions/: 包含编辑器操作相关的代码。
• demodel/: 包含编辑器模型相关的代码。
• deplumber/: 包含与 plumber 相关的代码。
• kbmap/: 包含键盘映射相关的代码。
• plugins/: 包含插件相关的代码。
• position/: 包含位置处理相关的代码。
• renderer/: 包含渲染相关的代码。
• scripts/: 包含脚本文件。
• vendor/9fans.net/go/: 包含第三方依赖。
• viewer/: 包含查看器相关的代码。
• .gitignore: Git 忽略文件。
• .travis.yml: Travis CI 配置文件。
• COMMANDS.md: 命令说明文档。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证文件。
• PLUGINS.md: 插件说明文档。
• PLUMBING.md: 管道（plumbing）说明文档。
• README.md: 项目介绍文档。
• USAGE.md: 使用说明文档。
• main.go: 项目的主入口文件。
• plugins.go: 插件管理相关的代码。
• plumber.go: 管道（plumber）相关的代码。
• plumber_plan9.go: 针对 Plan 9 系统的管道（plumber）代码。
• window.go: 窗口管理相关的代码。

2. 项目启动文件介绍

main.go

main.go 是项目的启动文件，负责初始化编辑器并启动主循环。以下是 main.go 的主要功能：

• 初始化编辑器: 加载配置、插件和键盘映射。
• 启动主循环: 处理用户输入、渲染界面和执行操作。

启动命令

go run main.go [filename]

3. 项目配置文件介绍

.gitignore

.gitignore 文件用于指定 Git 应该忽略的文件和目录，避免将不必要的文件提交到版本库中。

.travis.yml

.travis.yml 是 Travis CI 的配置文件，用于自动化构建和测试。

LICENSE

LICENSE 文件包含了项目的开源许可证信息，通常是 MIT 许可证。

README.md

README.md 是项目的介绍文档，包含了项目的基本信息、安装方法、使用说明等。

USAGE.md

USAGE.md 文件详细介绍了编辑器的使用方法，包括基本操作、快捷键、插件使用等。

PLUGINS.md

PLUGINS.md 文件介绍了如何编写和使用插件，扩展编辑器的功能。

PLUMBING.md

PLUMBING.md 文件介绍了如何使用管道（plumbing）功能，与外部工具进行交互。

COMMANDS.md

COMMANDS.md 文件列出了编辑器支持的所有命令及其用法。

CONTRIBUTING.md

CONTRIBUTING.md 文件提供了贡献指南，帮助开发者参与项目的开发和维护。

de A Programmer's Text Editor 项目地址: https://gitcode.com/gh_mirrors/de/de