yoannsculo/ucwiki

ucwiki is a tiny and static C wiki engine

µcwiki

µcwiki is a tiny and static C wiki engine. Meant to be as simple as possible. We just give a directory path as input, and the µcwiki transforms markup files into nice html pages powered with bootstrap.

The project is still in development, you can encounter some dirty bugs. Please don't hesitate to give me feedback. Thanks.

• Screenshot

How to build it

git submodule init
git submodule update
make

How to run it

./ucwiki

Usage

Usage: ucwiki [OPTIONS]
       -i	: input directory
       -o	: output directory

By default, input dir is doc and output dir is tmp. But you can specify input and output directories.

./ucwiki -i ./example -o ./output

For instance, just start your web browser here to see the result:

firefox ./output

See, markdown syntax to start your wiki.

TODO LIST

• [WISH] daemonize ucwiki to run in background and detect changes.
• [WISH] handle yaml headers
• [WISH] add a whitelist to copy just the files we need in extra.
• [WISH] add an index.html at root dir

Dependencies

• sundown - to render markdown files into html pages
• jQuery Treeview - for a fancy tree
• bootstrap - for a fancy css

LICENSE

Licensed under the terms of the MIT License (MIT) See the file COPYING for details.

Contact

Yoann Sculo - [email protected]