ReText 项目技术文档

ReText 项目技术文档

retext ReText: Simple but powerful editor for Markdown and reStructuredText 项目地址: https://gitcode.com/gh_mirrors/ret/retext

1. 安装指南

1.1 系统要求

• Python: 3.6 或更高版本
• 依赖模块:
  • PyQt6
  • Markups (2.0 或更高版本)
  • Markdown
  • docutils

1.2 安装步骤

1.2.1 使用 pip 安装

pip3 install ReText

• 默认情况下，pip 会进行系统范围的安装。如果需要安装到用户主目录，请添加 --user 参数。

1.2.2 手动下载安装

可以从 PyPI 下载 tarball 文件，然后手动安装。

1.3 推荐安装的额外模块

• pyenchant: 用于拼写检查支持
• chardet: 用于编码检测支持
• PyQt6-WebEngine: 提供更强大的预览引擎，支持 JavaScript

1.4 翻译文件

• 发布版本的 tarball 中已经包含了编译好的翻译文件，会自动加载。
• 对于开发版本，可以使用 lrelease ReText/locale/*.ts 命令编译翻译文件。
• 翻译文件也可以从 /usr/share/retext/ 目录加载。

2. 项目使用说明

2.1 启动 ReText

安装完成后，可以通过命令行启动 ReText：

retext

2.2 编辑文档

• ReText 支持 Markdown 和 reStructuredText 两种标记语言。
• 用户可以在左侧编辑区编写文档，右侧会实时预览渲染效果。

2.3 自定义标记语言

• 用户可以通过 Python 模块添加对自定义标记语言的支持，具体方法请参考 Custom Markups。

3. 项目 API 使用文档

3.1 主要模块

• PyQt6: 提供图形用户界面支持。
• Markups: 支持多种标记语言的解析和渲染。
• Markdown: 专门用于 Markdown 语言的解析。
• docutils: 专门用于 reStructuredText 语言的解析。

3.2 自定义标记语言

• 通过继承 AbstractMarkup 类并实现 convert() 方法，可以创建自定义的标记语言解析器。
• 使用 entry_points 机制注册自定义标记语言模块。

4. 项目安装方式

4.1 使用 pip 安装

pip3 install ReText

4.2 手动下载安装

1. 从 PyPI 下载 tarball 文件。
2. 解压文件并进入目录。
3. 运行安装命令：

   python3 setup.py install
   

4.3 开发环境安装

• 对于开发者，可以使用 pip 安装开发版本：

  pip3 install -e .
  

通过以上步骤，您可以顺利安装并使用 ReText 项目，享受其强大的 Markdown 和 reStructuredText 编辑功能。

retext ReText: Simple but powerful editor for Markdown and reStructuredText 项目地址: https://gitcode.com/gh_mirrors/ret/retext