summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/transient.mdwn (renamed from doc/plugins/contrib/transient.mdwn)23
-rw-r--r--doc/sandbox.mdwn2
-rw-r--r--doc/usage.mdwn2
3 files changed, 9 insertions, 18 deletions
diff --git a/doc/plugins/contrib/transient.mdwn b/doc/plugins/transient.mdwn
index 6003196b0..b7dd11906 100644
--- a/doc/plugins/contrib/transient.mdwn
+++ b/doc/plugins/transient.mdwn
@@ -1,7 +1,4 @@
-*For discussion and the branch please see [[todo/transient pages]]. If this
-plugin is merged, this page can be renamed to act as its documentation. --[[smcv]]*
-
-[[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]"]]
+[[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]" core=yes]]
[[!tag type/special-purpose]]
The `transient` plugin adds an underlay in `.ikiwiki/transient`, which is
@@ -15,21 +12,13 @@ is deleted automatically.
This plugin is mostly useful as something that other plugins can depend on:
-* [[plugins/contrib/album]] always writes photo-album "viewer" pages to the
- transient underlay
-
-Likely future users of this plugin (the appropriate branches need to be
-merged first):
-
-* with a patch (which exists but hasn't yet been tested), [[plugins/aggregate]]
- always writes aggregated posts into the transient underlay
-* with a patch, [[plugins/autoindex]] can be configured to auto-create missing
+* [[plugins/aggregate]] writes aggregated posts into the transient underlay
+* [[plugins/autoindex]] can be configured to auto-create missing
pages that have a [[ikiwiki/subpage]] or an [[plugins/attachment]], but not
commit them, in which case they go in the transient underlay
* [[plugins/comments]] can be configured to not commit comments: if so, it
- should probably put them in the transient underlay
-* with a patch, [[plugins/recentchanges]] always writes new changes into the
- transient underlay
-* with a patch, [[plugins/tag]] can be configured to auto-create missing
+ puts them in the transient underlay
+* [[plugins/recentchanges]] writes new changes into the transient underlay
+* [[plugins/tag]] can be configured to auto-create missing
tag pages but not commit them, in which case they go in the transient
underlay
diff --git a/doc/sandbox.mdwn b/doc/sandbox.mdwn
index bd0cc3c91..f40b288cb 100644
--- a/doc/sandbox.mdwn
+++ b/doc/sandbox.mdwn
@@ -87,3 +87,5 @@ lkj;kj;
how do
+
+This is super cool Joey!
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 2325b6502..b9516d740 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -60,7 +60,7 @@ These options control the mode that ikiwiki operates in.
* --clean
- This makes ikiwiki clean up by removing any files it denerated in the
+ This makes ikiwiki clean up by removing any files it generated in the
`destination` directory, as well as any configured wrappers, and the
`.ikiwiki` state directory. This is mostly useful if you're running
ikiwiki in a Makefile to build documentation and want a corresponding