WikiSH

From Christoph's Personal Wiki
Revision as of 22:31, 2 January 2015 by Christoph (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

WikiSH is a command line wiki using only /bin/sh and plain Awk. It also includes a Wiki Engine for a web server.

Installation

Installation is extremely easy:

  • Create a folder ~/.wiki/
  • Copy dot.wiki/* to ~/.wiki/
  • Copy wiki.sh to /usr/local/bin/ or some other place on the path

Commandline Usage

To make a HTML file from a wiki file call wiki.sh with the wiki file as parameter:

wiki.sh MyWiki.txt

This creates a HTML file called MyWiki.html.

For more information on wiki edititing see: http://wikish.do.homeunix.org/WikiFormattingGuide.html

Integration with vi

Add the following to your .vimrc:

 map <F6> :call Wikish()<CR><CR>

 " Wiki.sh file
 fun! Wikish()
   :!wiki.sh %
 endfun

Pressing F6 wikifies the currently open file in vi (i.e. runs wiki.sh on it and produces an HTML output file).

Notes

The default HTML is not XHTML and should be converted before using it. This, along with the CSS files, will make WikiSH web standards compliant. Simply running the output HTML file through HTML Tidy should fix most of the non-XHTML code. Or, you could just modify the script and CSS file (as I have done).

See also

External links