A Cookiecutter template for creating TiddlyWiki plugins.
This template creates the basic plugin structure as well as a documentation wiki. Run make inside the plugin directory to build the documentation wiki.
- Python 3.6+
- Cookiecutter
- Yarn
nameThe name of the plugin without the publisher namespace, e.g.,
$:/plugins/publisher/{{ name }}.project_slugThe name of plugin source directory, also used to construct the repository name.
publisherThe publisher namespace, e.g.,
$:/plugins/{{ publisher }}/name.typeOne of
plugin,theme, orlanguage.versionThe plugin version.
urlThe plugin homepage. Defaults to a GitHub repository URL.
authorYour full name.
emailYour email address.
descriptionA short description of the plugin. Also used as the site subtitle in the documentation wiki.
licenseChoose from one of several common open source licenses.
include_github_fork_ribbonInstall the official github-fork-ribbon plugin plugin. This adds a "Fork me on GitHub" ribbon to the top right corner of the documentation wiki.