Enki 文本编辑器技术文档

1. 安装指南

1.1 依赖安装

1.1.1 必备依赖

• Python 3
• PyQt5（需支持SVG）
• Qutepart
• PyQt5 QtWebEngine bindings（python3-pyqt5.qtwebengine 或 python3-qt5-webengine 包）

1.1.2 可选依赖

• Python-Markdown：用于Markdown预览
• Docutils：用于reStructuredText预览
• ctags：用于文件导航
• regex：用于预览同步
• CodeChat：用于源代码到HTML的转换（文学编程）
• Sphinx：用于构建Sphinx文档
• Flake8：用于Python代码的Lint检查

1.1.3 Debian及基于Debian的系统

apt-get install python3 libqt5svg5 python3-pyqt5 python3-pyqt5.qtwebengine python3-markdown python3-docutils ctags
pip3 install -r requirements.txt

如果您的仓库中没有 python3-pyqt5.qtwebengine，请移除 python3-pyqt5 和 python3-sip，然后执行 pip3 install PyQt5。

1.1.4 其他Unix系统

使用包管理器查找并安装上述依赖包。

1.1.5 其他系统

访问各项目的官方页面，下载并按照说明安装。

1.2 获取源代码

从 GitHub Releases 下载源代码压缩包。

1.3 安装Enki

python3 setup.py install

1.4 运行Enki

python3 -m enki

2. 项目使用说明

2.1 运行Enki

安装完成后，可以通过命令 python3 -m enki 启动Enki文本编辑器。

2.2 功能介绍

• 多语言支持：支持多种编程语言的语法高亮和代码补全。
• 预览功能：支持Markdown和reStructuredText的实时预览。
• 代码导航：通过ctags实现文件内代码导航。
• 代码Lint：支持Flake8进行Python代码的Lint检查。

3. 项目API使用文档

3.1 主要模块

• enki.core：核心模块，负责编辑器的基本功能。
• enki.plugins：插件模块，包含各种扩展功能。

3.2 常用API

• enki.core.Editor：编辑器主类，提供文本编辑、保存、加载等功能。
• enki.plugins.MarkdownPreview：Markdown预览插件，提供Markdown文件的实时预览功能。
• enki.plugins.CodeLint：代码Lint插件，提供代码检查功能。

4. 项目安装方式

4.1 通过预构建二进制文件安装

对于大多数Linux和Windows用户，可以从 官方网站 下载预构建的二进制文件进行安装。

4.2 从源代码安装

1. 安装依赖
2. 获取源代码
3. 执行安装命令 python3 setup.py install

通过以上步骤，您可以成功安装并使用Enki文本编辑器。如果在使用过程中遇到问题，请及时提交bug报告。