/tiddlywiki-starter-kit

📦 A modern and elegant notebook built with tiddlywiki and tailwindcss 🛩️

Primary LanguageJavaScriptMIT LicenseMIT

Important

TiddlyWiki starter kit has a large number of plugin dependencies and can be complex. I have done my best to fill in the plugin dependency information and handle any exceptions appropriately. However, it is recommended not to install the plugin separately unless you know how to handle it(bug or error) properly. The tiddlywiki starter kit will prioritize fixing bugs within this wiki under the time management's allowance. It is not fully compatible with other tiddlywiki plugins. It is recommended to use the tiddlywiki starter kit as a base for user

Features

  • 📦 Out of the box: TiddlyWiki Starter Kit comes with most configurations pre-packaged, reducing the need for tedious setup.
  • 🎨 Powered by Tailwind CSS: Utilizes Tailwind CSS for responsive design, minimizing the need for extensive style files.
  • 📚️ Multiple wiki support: Supports custom folders for different purposes such as work, life, reading, etc., making switching between them effortless.
  • 🚀 Quick operations: Provides keyboard shortcuts and full keyboard navigation for efficient workflow.
  • 🔧 Simplified configuration: Easily customize the TiddlyWiki Starter Kit by editing the .env file.
  • 💡 One-click installation: Quickly install the TiddlyWiki Starter Kit using the npm create create-neotw-app command.

Requirements

  • Node.js
  • Git(optional)

Getting Started

npm create neotw-app@latest

Configuration

Deploy

Fork this project, Go to vercel to deploy it manually

I recommend shallow cloning this project and deploying it manually on Vercel

Documentaion

Working through the night...