]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/plugins/contrib/remark.mdwn
f357401535d6642dbef1e3341c2398c7e0379e4c
[git.ikiwiki.info.git] / doc / plugins / contrib / remark.mdwn
1 [[!template id=plugin name=remark author="[[schmonz]]"]]
2 [[!template id=gitbranch branch=schmonz/remark author="[[schmonz]]"]]
3 [[!tag type/format]]
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 `---`.
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.
13 ## Problem: `inline`
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.
22 Should [[inline]] (and more generally [[ikiwiki/PageSpec]]) understand
23 that web slides are not exactly regular pages? And/or should this plugin
24 detect when slides are being inlined and allow ikiwiki to process the
25 Markdown as a sort of "preview"?
27 ## Concern: safety of web-editing
29 Even though `remarkpage.tmpl` has no action links, is it still possible
30 for someone to trick their way into web-editing a slide deck? And if
31 they do, is that dangerous?