A desktop wiki editor that stores your notes as plain-text wiki pages in a folder hierarchy, with links, attachments and plugins.
- Stars
- 8,702
- Forks
- 1,258
- Open issues
- 1,190
- Last commit
- 3 days ago
What is it?
TiddlyWiki is a personal web notebook built around small units of content called tiddlers, which can be linked together freely rather than organized in a fixed hierarchy. It works as a complete interactive wiki that can be saved as one self-contained HTML file, so the notebook stays usable without any hosted service.
For more advanced use, TiddlyWiki runs on Node.js with a client-server setup and a command line interface. The CLI can initialize new wikis, start a local server, load tiddlers from HTML files, render pages to static HTML, and build offline copies. The user interface itself is written in WikiText, so it can be customized and extended within the wiki.
The project is installed with npm, and upgrades are handled through the same package manager. Documentation and developer guides are hosted on tiddlywiki.com.
Key features
- 01Stores content as linked tiddlers instead of a fixed folder hierarchy.
- 02Runs as a single self-contained HTML file in any modern browser.
- 03Offers a Node.js client-server edition with a command line interface.
- 04Lets you render tiddlers to static HTML and build offline copies.
- 05User interface is implemented in WikiText and can be customized.
Use cases
- Keeping a personal notebook or knowledge base that you fully control.
- Running a self-hosted wiki on a local machine or server via Node.js.
- Generating static sites or documentation from a set of tiddlers.
- Customizing a wiki's interface and behavior with plugins.
Quick start
- 1
Install Node.js (macOS with Homebrew)
brew install node - 2
Install TiddlyWiki globally with npm
npm install -g tiddlywiki - 3
Create a new wiki folder with server components
tiddlywiki mynewwiki --init server - 4
Start the server, then visit http://127.0.0.1:8080/ in your browser
tiddlywiki mynewwiki --listen
Things to know
- The README does not state a clear license; the license could not be determined from the metadata.
- The Node.js server setup requires installing Node.js and npm, although a single HTML file version runs in a browser without it.
In collections
Topics
FAQ
- What is TiddlyWiki5?
- A non-linear personal wiki in JavaScript that runs as a single HTML file in the browser or as a Node.js application. TiddlyWiki is a personal web notebook built around small units of content called tiddlers, which can be linked together freely rather than organized in a fixed hierarchy. It works as a complete interactive wiki that can be saved as one self-contained HTML file, so the notebook stays usable without any hosted service.
- Is TiddlyWiki5 free to use? What license does it have?
- TiddlyWiki5 is open source under the Other license. Check the license terms before using it in commercial products.
- Is TiddlyWiki5 still maintained?
- Actively maintained. The last commit to TiddlyWiki5 was on Nov 4, 2026.
- What can I use TiddlyWiki5 for?
- Keeping a personal notebook or knowledge base that you fully control. Running a self-hosted wiki on a local machine or server via Node.js. Generating static sites or documentation from a set of tiddlers. Customizing a wiki's interface and behavior with plugins.
- How do I install TiddlyWiki5?
- Install Node.js (macOS with Homebrew): brew install node Install TiddlyWiki globally with npm: npm install -g tiddlywiki Create a new wiki folder with server components: tiddlywiki mynewwiki --init server Start the server, then visit http://127.0.0.1:8080/ in your browser: tiddlywiki mynewwiki --listen
- Where can I get TiddlyWiki5?
- The source code and installation instructions are on GitHub: https://github.com/TiddlyWiki/TiddlyWiki5
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
A self-hosted, database-less note-taking web app that stores notes as a flat folder of markdown files.
Self-hosted workspace combining documents, databases, whiteboards, handwritten notebooks and a daily journal, with optional local or cloud AI.
An open-source team knowledge base built with React and Node.js, offering realtime collaborative editing and Markdown support.
A starter vault, guide, skills and scripts for an AI agent that builds and maintains a linked markdown knowledge base in Claude Code and Obsidian.
A self-hosted, privacy-focused AI note-taking app for quickly capturing fleeting thoughts as Markdown cards with natural-language search.