https://github.com/bimlas/tw5-plugin-template
:warning: WIP TiddlyWiki plugin template
https://github.com/bimlas/tw5-plugin-template
Last synced: 8 months ago
JSON representation
:warning: WIP TiddlyWiki plugin template
- Host: GitHub
- URL: https://github.com/bimlas/tw5-plugin-template
- Owner: bimlas
- Created: 2024-02-04T21:22:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-09T18:23:59.000Z (over 2 years ago)
- Last Synced: 2025-01-18T18:54:15.268Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://bimlas.github.io/tw5-plugin-template
- Size: 113 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
:demo-page: https://MY-USER.github.io/tw5-MY-PLUGIN/
:json: https://MY-USER.github.io/tw5-MY-PLUGIN/tw5-MY-PLUGIN.json
= Plugin template repository for TiddlyWiki 5
*UNDER DEVELOPENT: THE TEMPLATE IS NOT COMPLETE, DO NOT USE IT*
A kickstart for your plugin development. Just fork this repository and change
the contents to your needs.
=== Search for these strings to replace
MY-USER::
Your GitHub user name (https://github.com/MY-USER/), same as your "TiddlyWiki
username" (`$:/plugins/MY-USER/MY-PLUGIN`).
MY-PLUGIN::
Name of the plugin, it's the same as the repository name without `tw5-` prefix
(https://github.com/MY-USER/tw5-MY-PLUGIN/).
=== Files of the plugin
README.adoc (this file)::
Main description, shown in the front page of the repository.
test/tiddlers/tests/::
Test files.
*Template starts here:*
'''
= MY-PLUGIN plugin for TiddlyWiki 5
For details, see the link:{demo-page}[demo page].
* https://github.com/MY-USER/tw5-MY-PLUGIN/ (please star if you like the plugin)
== 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
----
Running tests:
----
$ npm run test
----
Try out with the official wiki: it will import the tiddlers of
https://tiddlywiki.com/ to a local Node server and add the plugin so you can
try out on http://localhost:8888
----
$ npm run wiki
----