doc/plugins/contrib/remark.mdwn

   1 [[!template id=plugin name=remark author="[[schmonz]]"]]
   2 [[!template id=gitbranch branch=schmonz/remark.js author="[[schmonz]]"]]
   3 [[!tag type/format]]
   4
   5 [Remark.js](http://remarkjs.com) makes web slides from Markdown. This
   6 plugin integrates Remark into ikiwiki. Simply write `your_slides.remark`
   7 instead of `your_blog_post.mdwn`, separating slides with `---`.
   8
   9 To set shared styles across all presentations on your site, put them in
  10 a top-level `remarklocal.css`. To set per-presentation styles, use the
  11 [[localstyle]] plugin as usual.
  12
  13 ## Problem: `inline`
  14
  15 Web slides are sort of a regular web page, but not exactly: no action
  16 links, and almost none of the other accoutrements of `page.tmpl`. The
  17 branch's current behavior is that Remark slides are naively inlined like
  18 any other page, which -- because the Markdown is deliberately not being
  19 rendered by ikiwiki -- results in the slide source being displayed (and
  20 not elegantly). Clicking through to the slides works right, of course.
  21
  22 See [[Discussion#inline]].
  23
  24 ## Problem: safety of web-editing
  25
  26 This plugin is not currently safe for wikis where `.remark` pages can be
  27 edited by untrusted users; the [[plugins/htmlscrubber]] is unlikely to be
  28 able to prevent cross-site scripting in this plugin. Make sure only trusted
  29 (administrative) users can create or edit `.remark` pages.
  30
  31 See [[Discussion#editing]].