A TiddlyWiki generator for Yeoman

Usage no npm install needed!

<script type="module">
  import generatorTiddlywiki from '';


generator-tiddlywiki NPM version Build Status Dependency Status

A TiddlyWiki generator for Yeoman

This is a generator for creating a new TiddlyWiki from npm. It will establish a base directory structure and dependencies. Use it to manage a development server (locally) and to compile a fresh TiddlyWiki (stand-alone HTML). It uses Gulp as the build system with the following tasks:

  • npm start - Serve the TiddlyWiki as a web app ( with built in autosaving.
  • npm run build - Compile a stand alown HTML file from the stored tiddlers.
  • npm run deploy - This will copy the generated file to your server via SSH. (This feature is only available if you choose the deploy option as part of running the Yeoman script.)
  • npm run clean - Clean up any left ofer generated files.


First, install Yeoman and generator-tiddlywiki using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-tiddlywiki

Then generate your new project:

yo tiddlywiki

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced. Feel free to learn more about him.


Do What You Want to Public License (WYWTPL v3)