diff options
| author | Amitai Schlair <schmonz-web-ikiwiki@schmonz.com> | 2016-02-22 16:28:05 -0500 |
|---|---|---|
| committer | Amitai Schlair <schmonz-web-ikiwiki@schmonz.com> | 2016-02-22 16:28:05 -0500 |
| commit | acbefbea9a90009802799c9e68413bf0d84c4462 (patch) | |
| tree | 7118853a99ba476095f61cc53a1860add18d670e | |
| parent | f93544db761c8e778f7e66af5570113ddc774514 (diff) | |
| download | ikiwiki-acbefbea9a90009802799c9e68413bf0d84c4462.tar ikiwiki-acbefbea9a90009802799c9e68413bf0d84c4462.tar.gz | |
Document listsubscribe plugin.
| -rw-r--r-- | doc/plugins/contrib/listsubscribe.mdwn | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/plugins/contrib/listsubscribe.mdwn b/doc/plugins/contrib/listsubscribe.mdwn new file mode 100644 index 000000000..0b93cde22 --- /dev/null +++ b/doc/plugins/contrib/listsubscribe.mdwn @@ -0,0 +1,25 @@ +[[!template id=plugin name=listsubscribe author="[[schmonz]]"]] +[[!template id=gitbranch branch=schmonz/listsubscribe author="[[schmonz]]"]] +[[!tag type/web]] + +This plugin provides the `listsubscribe` directive, which inserts a web +form for your readers to subscribe to a mailing list. The directive +takes a required `listname` parameter, which must refer to one of the +lists named in the wiki setup file. + +## Example + +In `ikiwiki.setup`: + + add_plugins: + - listsubscribe + + listsubscribe: + 'my supercool mailing list': supercool-subscribe@neato.great + +(Where `supercool-subscribe@neato.great` is the subscription address +provided by your mailing list manager.) + +In any wiki page: + + [[!listsubscribe listname="my supercool mailing list"]] |