https://github.com/bimlas/tw5-kin-filter
TiddlyWiki plugin: Recursively looking for kinship between tiddlers
https://github.com/bimlas/tw5-kin-filter
fields filter recursive tags tiddlywiki-plugin tiddlywiki5
Last synced: 11 months ago
JSON representation
TiddlyWiki plugin: Recursively looking for kinship between tiddlers
- Host: GitHub
- URL: https://github.com/bimlas/tw5-kin-filter
- Owner: bimlas
- Created: 2019-02-12T07:29:04.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-02-18T21:35:45.000Z (about 2 years ago)
- Last Synced: 2025-03-31T14:40:36.372Z (12 months ago)
- Topics: fields, filter, recursive, tags, tiddlywiki-plugin, tiddlywiki5
- Language: JavaScript
- Homepage: https://bimlas.github.io/tw5-kin-filter
- Size: 614 KB
- Stars: 21
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
:demo-page: https://bimlas.github.io/tw5-kin-filter
:json: https://bimlas.github.io/tw5-kin-filter/tw5-kin-filter.json
= Kin filter plugin for TiddlyWiki 5
For details, see the link:{demo-page}[demo page].
* https://github.com/bimlas/tw5-kin-filter (please star if you like it)
== What others say about it?
"...it is so elegant and powerful that in someways, it is hard to believe."
-- https://groups.google.com/d/msg/tiddlywiki/YZlPGP0qX1o/Qh-sAWEuCQAJ[TonyM]
"...it is incredibly powerful..."
-- https://groups.google.com/d/msg/tiddlywiki/YZlPGP0qX1o/pxFtAmS7AgAJ[LorenzGL]
"Great tool and unique in the field."
-- https://groups.google.com/d/msg/tiddlywiki/-oXz38N1BM4/AVKjrOnlAwAJ[Mohammad]
"Thank you so much for you work on this, and the excellent documentation complete with figures!"
-- https://groups.google.com/d/msg/tiddlywiki/YZlPGP0qX1o/NtTBuVPUBgAJ[Diego Mesa]
"Thanks @bimlas this is a high quality PR, and I appreciate the care you've taken with the documentation particularly."
-- https://github.com/Jermolene/TiddlyWiki5/pull/3511#pullrequestreview-176711457[Jermolene]
== How to install?
=== Drag-n-drop
- Open the link:{demo-page}[demo page]
- Drag-n-drop the plugin tiddler in to your wiki
=== Download as JSON
- Download the link:{json}[JSON archive of the plugin] (_Right click -> Save as_)
- Drag-n-drop the file in to your wiki
=== 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
----
Try out on a copy of https://tiddlywiki.com/ at http://localhost:8888/
----
$ npm run wiki
----