rsted 项目技术文档

1. 安装指南

环境要求

在开始安装之前，请确保您的系统满足以下要求：

• Python 环境（建议使用 Python 3.x）
• Flask
• rst2html（来自 Docutils）

安装步骤

1. 创建虚拟环境（可选但推荐）：

   python -m venv venv
   source venv/bin/activate
   

2. 安装依赖：

   pip install -r pip-requirements.txt
   

2. 项目的使用说明

启动项目

在安装完成后，您可以通过以下步骤启动项目：

1. 本地启动：

   ./application.py
   

   启动后，项目将在本地端口 5000 上运行。您可以通过浏览器访问 http://localhost:5000/ 来使用在线编辑器。

2. 使用 Docker 启动：

   docker build -t rsted .
   docker run --name rsted --rm -p 5000:5000 rsted
   

   启动后，项目同样将在本地端口 5000 上运行。您可以通过浏览器访问 http://localhost:5000/ 来使用在线编辑器。

3. 项目API使用文档

API 概述

rsted 项目主要提供了一个基于 Flask 的在线 reStructuredText 编辑器。用户可以通过浏览器访问编辑器，输入 reStructuredText 格式的内容，并实时查看渲染后的 HTML 输出。

API 使用示例

由于 rsted 项目主要是一个 Web 应用，API 的使用主要通过浏览器界面进行。用户在浏览器中输入 reStructuredText 格式的文本，编辑器会自动将其转换为 HTML 并显示在页面上。

4. 项目安装方式

本地安装

1. 克隆项目：

   git clone https://github.com/your-repo/rsted.git
   cd rsted
   

2. 安装依赖：

   pip install -r pip-requirements.txt
   

3. 启动项目：

   ./application.py
   

Docker 安装

1. 构建 Docker 镜像：

   docker build -t rsted .
   

2. 运行 Docker 容器：

   docker run --name rsted --rm -p 5000:5000 rsted
   

通过以上步骤，您可以成功安装并运行 rsted 项目，享受在线 reStructuredText 编辑器的便捷功能。