Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[ikiwiki] / doc / todo / preview_changes_before_git_commit.mdwn
1 ikiwiki allows to commit changes to the doc wiki over the `git://...` protocol.
2 It would be nice if there'd be a uniform way to view these changes before `git
3 push`ing.  For the GNU Hurd's web pages, we include a *render_locally* script,
4 <http://www.gnu.org/software/hurd/render_locally>, with instructions on
5 <http://www.gnu.org/software/hurd/contributing/web_pages.html>, section
6 *Preview Changes*.  With ikiwiki, one can use `make docwiki`, but that excludes
7 a set of pages, as per `docwiki.setup`.  --[[tschwinge]]
8
9 > `ikiwiki -setup some.setup --render file.mdwn` will build the page and
10 > dump it to stdout. So, for example:
11
12         ikiwiki -setup docwiki.setup --render doc/todo/preview_changes_before_git_commit.mdwn | w3m -T text/html
13
14 > You have to have a setup file, though it suffices to make up your own
15 > if you don't have the real one. Using ikiwiki.info's real setup file
16 > won't actually work since it uses a search plugin that gets unhappy
17 > if this is not in `/srv/web/ikiwiki.info`. --[[Joey]]