feat: rename project to TTTK
- Update package name and CLI binary to 'tttk' - Revise documentation to reflect new name - Add default serve behavior when no subcommand is given - Add directory existence check in serve command - Refactor inline comments to Chinese
This commit is contained in:
@@ -1,18 +1,12 @@
|
||||
# TTRPG Tools
|
||||
# TTTK — Tabletop Toolkit
|
||||
|
||||
一个基于 `solid.js` 和 `rsbuild` 的 TTRPG 工具箱,支持 Markdown 解析、自定义组件和 CLI 工具。
|
||||
A TTRPG content preview and compilation tool based on `solid.js` and `rsbuild`. Write markdown, preview in browser.
|
||||
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
# 安装依赖
|
||||
npm install
|
||||
|
||||
# 全局安装 CLI
|
||||
npm link
|
||||
|
||||
# 预览内容
|
||||
ttrpg serve ./content
|
||||
# 无需安装,直接使用
|
||||
npx tttk serve ./content
|
||||
```
|
||||
|
||||
## 文档导航
|
||||
@@ -20,6 +14,7 @@ ttrpg serve ./content
|
||||
| 文档 | 说明 |
|
||||
|------|------|
|
||||
| [📖 CLI 使用说明](./docs/cli.md) | CLI 安装、命令和用法 |
|
||||
| [📦 npm](https://www.npmjs.com/package/tttk) | `npx tttk serve ./content` |
|
||||
| [🛠️ 开发指南](./docs/development.md) | 项目结构、开发规范和构建 |
|
||||
| [📝 Markdown 编写说明](./docs/markdown.md) | Markdown 语法和组件用法 |
|
||||
| [📊 CSV 编写说明](./docs/csv.md) | CSV 文件格式、字段定义、变量语法 |
|
||||
@@ -27,7 +22,7 @@ ttrpg serve ./content
|
||||
|
||||
## 功能概览
|
||||
|
||||
- **CLI 工具**: `serve` 预览模式 和 `compile` 编译模式
|
||||
- **CLI 工具**: `tttk serve` 预览模式 和 `tttk compile` 编译模式
|
||||
- **Markdown 解析**: 支持指令语法、YAML 标签、mermaid 图表
|
||||
- **TTRPG 组件**: 骰子、表格、卡牌、标记、命令追踪器等
|
||||
|
||||
|
||||
Reference in New Issue
Block a user