Skip to content

tiddly-gittly/super-tag

Repository files navigation

English | 中文

SuperTag plugin for TiddlyWiki5

Auto generate input form on a tiddler by simply adding a SuperTag to it. Create a SuperTag by compositing existing TraitTags.

See following resources to learn how to use:

Acknowledgement

Use json-editor/json-editor for form rendering. AFAIK joshuafontany/TW5-jsoneditor is using it too.

(Not using eclipsesource/jsonforms because we need vanilly js renderer, without ReactJS).

During development

There are some scripts you can run to boost your development.

After npm i --legacy-peer-deps:

  • npm run dev to pack the plugin in the dist/ directory, this will setup a site that will auto reload when you have changes. But this is development mode, will produce a much larget bundle than the final version, so only for dev.
  • npm run dev-html to setup the demo site locally. Re-run this command and refresh browser to see changes. In this way you can see the real bundle size same as your user will get.

You will need --legacy-peer-deps when npm i if you are using latest nodejs. This is a bug in npm.

Add a second ts file

Add new file name (without .ts) to package.json's tsFiles field. And build script will read it and compile files in it.

After the plugin is complete

Publish

Enable github action in your repo (in your github repo - setting - action - general) if it is not allowed, and when you tagging a new version vx.x.x in a git commit and push, it will automatically publish to the github release.