yiki/README.md

# yiki - the yellows111 "wiki"

Takes a bunch of Markdown (\*.md) files (default is from `docs`),
and renders to HTML with preserved directory paths.

## Features

* Table of Contents on every page.
* Preserved directory paths.
* All headers can be jumped to.

## Motivation

Just felt like writing it so I could write markdown instead of
working with HTML syntax rules for my documentation/research archive.

## Licensing

MIT. Review the `LICENSE` file if required.

## How to use

You need a copy of GNU make (GPL-3 licensed software).

Use the `gmake` (or if it's the system makefile parser, `make`) command
after writing Markdown (\*.md) files to the `docs` directory.

Afterwards, check the `build` directory for the `.html` files.

Otherwise, if you just want to use `yiki` to render one file:

`node compile source.md target.htm`

## Options

`WIKINAME` Specify what the "A new yiki!" text should be replaced with.

Example: `gmake WIKINAME="I love options!"`

## Contributing

I request (but not require) that you modify files without Carriage Returns,
and to terminate new or modified files with a Line Feed character.