ITADN
oeyoews/tiddlywiki-starter-kit
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

badge badge badge badge badge badge


Stackblitz 演示 | 文档 | 中文

特性

  • 📦 开箱即用:TiddlyWiki Starter Kit 预置了大部分配置,减少了繁琐的设置需求。
  • 🎨 由 Tailwind CSS 驱动:利用 Tailwind CSS 实现响应式设计,最大限度地减少了对大量样式文件的需求。
  • 📚️ 多 Wiki 支持:支持为工作、生活、阅读等不同用途创建自定义文件夹,使它们之间的切换变得轻松自如。
  • 🚀 快速操作:提供键盘快捷键和完整的键盘导航,以实现高效的工作流程。
  • 🔧 简化配置:通过编辑 .env 文件轻松自定义 TiddlyWiki Starter Kit。
  • 💡 一键安装:使用 npm create create-neotw-app 命令快速安装 TiddlyWiki Starter Kit。

要求

  • Node.js(含 npm)
  • Git(可选)
graph LR;
NodeJs & TiddlyWiki5 & Git -.-> Local --> GitHub --> Build -.->  b[[Blog Page]]

sequenceDiagram
autonumber
    actor user as TiddlyWiki5 用户
    participant nodejs as TiddlyWiki5 Node.js
    participant website as 浏览器
    participant git as Git
    participant github as GitHub
    user ->>+ github : 克隆 TiddlyWiki5 Starter Kit 仓库, 安装依赖
    user ->> nodejs : 启动 TiddlyWiki5 Node.js
    nodejs ->>+ website : 进入 TiddlyWiki
    website -->>- nodejs : 文件变动同步到项目文件夹 /tiddlers
    loop
		nodejs --> website:文件同步
	end
    user ->> git : 提交 /tiddlers 文件
    git ->> github : 保存到 GitHub

入门

npm create neotw-app@latest

部署

Fork 此项目,前往 Vercel 手动部署

我建议使用浅克隆方式克隆此项目,并在 Vercel 上手动部署