Metadata-Version: 2.4
Name: scriptbook
Version: 2.0.1
Summary: ScriptBook - Interactive terminal and document browser with web interface
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: tornado>=6.4
Requires-Dist: terminado>=0.18
Provides-Extra: test
Requires-Dist: pytest>=7.0.0; extra == "test"
Requires-Dist: pytest-cov>=4.0.0; extra == "test"

# 项目名称

- [特性](#特性)
- [快速开始](#快速开始)
- [文档](#文档)

## 特性

| 功能 | 状态 | 备注 |
|------|------|------|
| 前端 Terminal 组件，支持发送脚本给后端执行，支持交互，页面刷新不影响脚本执行，支持现代化的终端体验。技术选型上，前端使用 xterm.js，后端使用 tornado 和 terminado | 开发完成 | 基于 xterm.js + tornado + terminado 实现 |
| 后端命令支持传一个目录参数，前端提供组件展示目录下 markdown 文件 | 开发完成 | 已实现文件浏览器和 markdown 查看器 |
| 命令行工具支持接受 markdown 文件和脚本 id 作为输入并执行脚本 | 下线完成 | 目前只支持 bash 脚本块 |
| 前端特殊处理 markdown 文件里的 bash 代码块，渲染按钮点击可拷贝代码到终端执行 | 开发完成 | 已集成到 markdown 查看器中 |

## 快速开始

```bash
```

## 文档
