1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-26 18:10:27 +00:00
TiddlyWiki5/plugins/tiddlywiki/railroad/doc/readme.tid
Jermolene f2a7f00870 Improve plugin readmes
Now every plugin has a short, introductory readme tiddler that is shown
in the online plugin library.
2015-03-19 10:53:45 +00:00

10 lines
690 B
Plaintext

created: 20150102163222184
modified: 20150119231005000
title: $:/plugins/tiddlywiki/railroad/readme
This plugin provides a `<$railroad>` widget for generating railroad diagrams as SVG images.
Alternatively, the [[diagram notation|$:/plugins/tiddlywiki/railroad/syntax]] can be stored in a dedicated tiddler with its `type` field set to `text/vnd.tiddlywiki.railroad`, and that tiddler can simply be transcluded to wherever it is needed.
The plugin is based on [[a library by Tab Atkins|https://github.com/tabatkins/railroad-diagrams]], and has been extended to make it more flexible, including allowing components of a diagram to function as links or be transcluded from other tiddlers.