Skip to content

PaulBatchelor/weewiki

Repository files navigation

WeeWiki

WeeWiki is a wee little wiki engine used to generate personal wikis and mind maps.

Building

WeeWiki is written in a literate style, and requires Worgle to tangle files into C code. Make sure SQLite is installed as well.

WeeWiki can be built using the command “make”. It can then be installed using “sudo make install”.

QuickStart

To make a new page called foo:

weewiki add foo

Then, set foo to be some text:

weewiki set foo "here is a page callled foo"

If one desires to edit the page in the text editor defined by $EDITOR:

weewiki edit foo

Save + close, and this will update the page.

To upload this README to be the homepage:

weewiki push README.org index

By default, wiki writes to _site/weewiki, so make sure this directory exists:

mkdir -p _site/wiki

List all the pages with

weewiki ls

Export all the pages to HTML with:

weewiki export

And there now should be some HTML content written to _site/wiki. Setting a http fileserver to point to _site, one can see the generated homepage /wiki, and the foo page /wiki/foo.

Releases

No releases published

Packages

No packages published

Languages