docs: 补全 /gap 命令、预设说明、配置持久化文档
基于 grammy 的 Telegram 机器人,排版能力由 Typeseter 提供。
grammy
Typeseter
本项目不再维护一份独立排版核心,直接依赖 GitHub 上的 Typeseter:
typeseter
github:TinySnow/Typeseter#master
详细对接文档见:docs/typeseter-github-integration.md
/settings
/mode <plain|markdown>
/toggle <选项名或 key>
/gap <0|1|2|分隔符>
/preset <poetry|default|strict>
poetry
strict
default
/reset
npm install
npm run start
.env
npm run build
node dist/main.js
docker compose up -d --build
配置通过 docker-compose.yml 中的 volume 挂载 config.json 持久化,容器重建不丢失。
docker-compose.yml
config.json
BOT_TOKEN
SOCKS_PROXY
socks5h://127.0.0.1:7890
TARGET_CHAT_ID
master
self-use
MIT
版权所有:中国计算机学会技术支持:开源发展技术委员会 京ICP备13000930号-9 京公网安备 11010802047560号
telegram-typeseter-bot
基于
grammy的 Telegram 机器人,排版能力由Typeseter提供。现在的接入方式
本项目不再维护一份独立排版核心,直接依赖 GitHub 上的
Typeseter:typeseter:github:TinySnow/Typeseter#master详细对接文档见:docs/typeseter-github-integration.md
命令列表
/settings— 查看当前所有排版选项(含 key 名和段落间距)/mode <plain|markdown>— 切换排版模式/toggle <选项名或 key>— 开关某个选项(支持中文标签或 key 名,无需 on/off)/gap <0|1|2|分隔符>— 设置段落间距/preset <poetry|default|strict>— 应用预设配置poetry:维持空行 + 首行不缩进 + md 缩减连续空行strict:全选项开启default:恢复默认/reset— 恢复默认设置Quickstart
生产环境部署
自编译
.env文件Docker
.env文件docker compose up -d --build配置通过
docker-compose.yml中的 volume 挂载config.json持久化,容器重建不丢失。环境变量
BOT_TOKENSOCKS_PROXYsocks5h://127.0.0.1:7890)TARGET_CHAT_IDBranch 约定
master:对外公开,建议依赖稳定 commit/tag。self-use:自用部署分支,可先追新再回灌到master。License
MIT