ccalathea/README.md

1.2 KiB

calathea v0.1

calathea is a small C program used to generate static wikis. It takes a directory of Common Markdown pages with [[wikilinks]] and renders them to HTML. The output is a flat directory of HTML pages where the wikilinks are converted to relative links.

This is also my first full, complete project written entirely in C, which has proved to be a serious trial by fire in learning how to effectively work with zero-terminated strings. There will likely be memoryleaks and comments that over explain every line of code.

Features

  • Rendering wikilinks
  • Ability to keep track of incoming links
  • Named wikilinks (i.e. [[link title|actual page]])

installation

This tool requires cmark to be installed. Once that's set up, clone the repository and run:

$ make

If GCC complains it can't find cmark, then try running ldconfig. If it still doesn't work, then run echo $LD_LIBRARY_PATH. If it doesn't show anything, you've got to add the right directory to the path, i.e.,

$ export $LD_LIBRARY_PATH=/usr/local/lib64

Or wherever it got installed as per the output of running make install for cmark.