Skip to content

bimlas/tw5-kin-filter

Repository files navigation

Kin filter plugin for TiddlyWiki 5

For details, see the demo page.

What others say about it?

…​it is so elegant and powerful that in someways, it is hard to believe.
TonyM
…​it is incredibly powerful…​
LorenzGL
Great tool and unique in the field.
Mohammad
Thank you so much for you work on this, and the excellent documentation complete with figures!
Thanks @bimlas this is a high quality PR, and I appreciate the care you’ve taken with the documentation particularly.
Jermolene

How to install?

Drag-n-drop

  • Open the demo page

  • Drag-n-drop the plugin tiddler in to your wiki

Download as JSON

Copy to directory based (Node.js) wiki

  • Clone or download this repository

  • Copy the plugins directory to the root directory of your wiki

Development

Start by installing dependencies:

$ npm ci

Build demo HTML and plugin JSON files:

$ npm run build

Run tests:

$ npm run test

Test performance by running different queries on a copy of https://tiddlywiki.com/:

$ npm run test:performance
$ npm run wiki