oh, we don't use comments here, do we?

[git.ikiwiki.info.git] / doc / todo / preview_changes_before_git_commit.mdwn

diff --git a/doc/todo/preview_changes_before_git_commit.mdwn b/doc/todo/preview_changes_before_git_commit.mdwn
index e0e6ba8662ef3cc345d38d35c1b7485b45993439..187497cf40d24ec717cde56c36dd1baef234bd57 100644 (file)
--- a/doc/todo/preview_changes_before_git_commit.mdwn
+++ b/doc/todo/preview_changes_before_git_commit.mdwn
@@ -5,3 +5,13 @@ push`ing.  For the GNU Hurd's web pages, we include a *render_locally* script,
 <http://www.gnu.org/software/hurd/contributing/web_pages.html>, section
 *Preview Changes*.  With ikiwiki, one can use `make docwiki`, but that excludes
 a set of pages, as per `docwiki.setup`.  --[[tschwinge]]
+
+> `ikiwiki -setup some.setup --render file.mdwn` will build the page and
+> dump it to stdout. So, for example:
+
+       ikiwiki -setup docwiki.setup --render doc/todo/preview_changes_before_git_commit.mdwn | w3m -T text/html
+
+> You have to have a setup file, though it suffices to make up your own
+> if you don't have the real one. Using ikiwiki.info's real setup file
+> won't actually work since it uses a search plugin that gets unhappy
+> if this is not in `/srv/web/ikiwiki.info`. --[[Joey]]