Skip to content

Commit b2f2563

Browse files
OaklightOaklight
committed
docs: optimize GitHub presence for discoverability
Reposition tinyleaf as a lightweight Overleaf alternative. Add badges, comparison table, keywords, and PyPI classifiers to improve search visibility on GitHub and PyPI.
1 parent 8adbb2c commit b2f2563

3 files changed

Lines changed: 82 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
11
# tinyleaf
22

3-
[中文版](./README_zh.md)
3+
[![PyPI](https://img.shields.io/pypi/v/tinyleaf)](https://pypi.org/project/tinyleaf/)
4+
[![Python](https://img.shields.io/pypi/pyversions/tinyleaf)](https://pypi.org/project/tinyleaf/)
5+
[![License](https://img.shields.io/github/license/Oaklight/tinyleaf)](./LICENSE)
6+
[![Documentation](https://img.shields.io/badge/docs-readthedocs-blue)](https://tinyleaf.readthedocs.io)
47

5-
Lightweight, zero-dependency web-based LaTeX editor. Powered by [TeX Live Docker images](https://github.com/Oaklight/texlive).
8+
[中文版](./README_zh.md) | [Documentation](https://tinyleaf.readthedocs.io)
9+
10+
A lightweight, self-hosted **Overleaf alternative** that runs entirely from a single `pip install`. No database, no Node.js, no Docker required — just Python's standard library and a TeX Live installation. One command to start editing LaTeX in your browser.
11+
12+
```bash
13+
pip install tinyleaf && tinyleaf /path/to/my-thesis
14+
```
15+
16+
<!-- Screenshot / demo GIF placeholder — replace with actual media -->
17+
<!-- ![tinyleaf screenshot](docs/images/screenshot.png) -->
618

719
## Features
820

@@ -82,6 +94,20 @@ docker compose up
8294

8395
This starts the web editor on `http://localhost:14159` with a persistent TeX Live container for compilation.
8496

97+
## Why tinyleaf?
98+
99+
| | tinyleaf | Overleaf CE |
100+
|---|---------|-------------|
101+
| Install | `pip install tinyleaf` | Docker Compose (MongoDB + Redis + Node + CLSI + …) |
102+
| Dependencies | **Zero** (Python stdlib only) | 6+ services |
103+
| Memory | ~30 MB | ~1 GB+ |
104+
| Startup | Instant | Minutes |
105+
| Compilation | Local `latexmk` or Docker | Built-in CLSI |
106+
| Git | Built-in UI | Server-side Git bridge |
107+
| Collaboration | Single-user | Multi-user |
108+
109+
tinyleaf is designed for **individual users** who want a browser-based LaTeX editing experience without the operational overhead of a full Overleaf deployment.
110+
85111
## License
86112

87113
MIT

‎README_zh.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
11
# tinyleaf
22

3-
[English Version](./README.md)
3+
[![PyPI](https://img.shields.io/pypi/v/tinyleaf)](https://pypi.org/project/tinyleaf/)
4+
[![Python](https://img.shields.io/pypi/pyversions/tinyleaf)](https://pypi.org/project/tinyleaf/)
5+
[![License](https://img.shields.io/github/license/Oaklight/tinyleaf)](./LICENSE)
6+
[![Documentation](https://img.shields.io/badge/docs-readthedocs-blue)](https://tinyleaf.readthedocs.io)
47

5-
轻量级、零依赖的 Web LaTeX 编辑器。基于 [TeX Live Docker 镜像](https://github.com/Oaklight/texlive)。
8+
[English Version](./README.md) | [文档](https://tinyleaf.readthedocs.io)
9+
10+
轻量级、可自托管的 **Overleaf 替代方案**，只需一条 `pip install` 即可运行。无需数据库、无需 Node.js、无需 Docker——仅依赖 Python 标准库和 TeX Live。一条命令即可在浏览器中编辑 LaTeX。
11+
12+
```bash
13+
pip install tinyleaf && tinyleaf /path/to/my-thesis
14+
```
15+
16+
<!-- 截图 / 演示 GIF 占位 — 替换为实际素材 -->
17+
<!-- ![tinyleaf 截图](docs/images/screenshot.png) -->
618

719
## 功能
820

@@ -82,6 +94,20 @@ docker compose up
8294

8395
Web 编辑器将在 `http://localhost:14159` 启动，并使用持久化的 TeX Live 容器进行编译。
8496

97+
## 为什么选择 tinyleaf？
98+
99+
| | tinyleaf | Overleaf CE |
100+
|---|---------|-------------|
101+
| 安装 | `pip install tinyleaf` | Docker Compose（MongoDB + Redis + Node + CLSI + …） |
102+
| 依赖 | **零**（仅 Python 标准库） | 6+ 个服务 |
103+
| 内存占用 | ~30 MB | ~1 GB+ |
104+
| 启动速度 | 即时 | 数分钟 |
105+
| 编译方式 | 本地 `latexmk` 或 Docker | 内置 CLSI |
106+
| Git 集成 | 内置 UI | 服务端 Git Bridge |
107+
| 协作 | 单用户 | 多用户 |
108+
109+
tinyleaf 专为**个人用户**设计，提供浏览器内的 LaTeX 编辑体验，无需承担完整 Overleaf 部署的运维开销。
110+
85111
## 许可证
86112

87113
MIT

‎pyproject.toml‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,37 @@ build-backend = "setuptools.build_meta"
66
name = "tinyleaf"
77
dynamic = ["version"]
88
authors = [{ name = "Oaklight", email = "oaklight@users.noreply.github.com" }]
9-
description = "Lightweight web-based LaTeX editor powered by TeX Live"
9+
description = "A lightweight, self-hosted Overleaf alternative — zero-dependency LaTeX web editor"
1010
readme = "README.md"
1111
requires-python = ">=3.10"
1212
license = "MIT"
13+
keywords = [
14+
"latex",
15+
"editor",
16+
"overleaf",
17+
"texlive",
18+
"self-hosted",
19+
"web-editor",
20+
"pdf",
21+
"codemirror",
22+
]
23+
classifiers = [
24+
"Development Status :: 4 - Beta",
25+
"Environment :: Web Environment",
26+
"Intended Audience :: Science/Research",
27+
"Intended Audience :: Education",
28+
"Topic :: Text Processing :: Markup :: LaTeX",
29+
"Topic :: Text Editors",
30+
"Framework :: AsyncIO",
31+
"Programming Language :: Python :: 3",
32+
"Programming Language :: Python :: 3.10",
33+
"Programming Language :: Python :: 3.11",
34+
"Programming Language :: Python :: 3.12",
35+
"Programming Language :: Python :: 3.13",
36+
]
1337

1438
[project.urls]
39+
Documentation = "https://tinyleaf.readthedocs.io"
1540
Repository = "https://github.com/Oaklight/tinyleaf"
1641
Issues = "https://github.com/Oaklight/tinyleaf/issues"
1742

0 commit comments

Comments
 (0)