<center>
    <img src="https://cdn.jsdelivr.net/gh/oeyoews/tiddlywiki-starter-kit@main/docs/public/img/tiddlywiki-starter-kit.webp" title="tiddlywiki starter kit" class="spotlight rounded-lg" />

<img src="https://img.shields.io/badge/tiddlywiki-black?style=flat-square&logo=tiddlywiki&logoColor=white" alt="badge"> <img src="https://img.shields.io/badge/tailwindcss-black?style=flat-square&logo=tailwindcss&logoColor=white" alt="badge"> <img src="https://img.shields.io/badge/nodejs-black?style=flat-square&logo=node.js&logoColor=white" alt="badge"> <img src="https://img.shields.io/badge/typescript-black?style=flat-square&logo=typescript&logoColor=white" alt="badge"> <img src="https://img.shields.io/badge/vue-black?style=flat-square&logo=vue.js&logoColor=white" alt="badge">

[在线演示](https://tiddlywiki-starter-kit.vercel.app) | [在线文档](https://tiddlywiki-starter-kit.vercel.app/docs/) | [Stackblitz 体验](https://stackblitz.com/~/github.com/oeyoews/tiddlywiki-starter-kit)

</center>

## 🎯 项目简介

TiddlyWiki Starter Kit 是一个现代化的 TiddlyWiki 开发模板，集成了多种实用工具和优化配置，让你的 Wiki 开发更加轻松高效。

## ✨ 特性

- 📦 **开箱即用**: 预配置了常用插件和主题，无需繁琐设置
- 🎨 **现代化样式**: 集成 Tailwind CSS，提供响应式设计支持
- 🚀 **性能优化**: 内置构建优化，确保快速加载和流畅体验
- 🔌 **插件系统**: 丰富的插件生态，支持自定义扩展
- 🌐 **多端同步**: 支持多种部署方式，数据轻松同步
- 🛠️ **开发工具**: 集成 TypeScript、Vue3 等现代开发工具
- 📱 **移动适配**: 完善的移动端支持，随时随地访问

## 🚀 快速开始

### 环境要求

- Node.js >= 18
- Git (可选)
- pnpm (推荐)

### 安装

```bash
npm create neotw-app@latest
```

### 开发

```bash
pnpm dev        # 启动开发服务器
pnpm build      # 构建生产版本
pnpm serve      # 预览生产版本
```

## 📦 项目结构

```plaintext
tiddlywiki-starter-kit/
├── config/           # 构建配置
├── docs/            # 文档
├── plugins/         # 插件目录
├── themes/          # 主题
├── packages/        # 工具包
└── templates/       # 模板文件
```

## 🔧 配置说明

主要配置文件：
- `.env`: 环境变量配置
- `tiddlywiki.config.mjs`: TiddlyWiki 配置
- `config/`: 构建相关配置

## 🚢 部署

1. Fork 本项目
2. 连接到 Vercel
3. 配置环境变量
4. 一键部署

## 🤝 贡献指南

欢迎提交 Issue 和 Pull Request！

1. Fork 本项目
2. 创建特性分支
3. 提交改动
4. 推送到分支
5. 提交 Pull Request

## 📝 许可证

[MIT License](LICENSE)

## 🙏 鸣谢

- [TiddlyWiki](https://tiddlywiki.com/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Vue.js](https://vuejs.org/)
- [Vercel](https://vercel.com/)

## 📮 联系方式

- GitHub Issues: [提交问题](https://github.com/oeyoews/tiddlywiki-starter-kit/issues)
- 文档: [查看文档](https://tiddlywiki-starter-kit.vercel.app/docs/)