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

`node ymake`, set options using `export` commands.

An alternative makefile for GNU make is avaliable if it is prefered.

Either way, you'll want to write Markdown (\*.md) files to the 
`docs` (which is the default `SRC_DIRS`) directory.

Afterwards, check the `build` (`BUILD_DIR`) directory for the `.html` files.

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

`node compile source.md target.htm`


## Options

`SRC_DIRS` Specify the directory which `yiki` compiles files from.

ymake: `export SRC_DIRS="./input"`

GMake: `gmake SRC_DIRS="./input"`



`BUILD_DIR` Specify the directory which `yiki` compiles files into.

ymake: `export BUILD_DIR="./output"`

GMake: `gmake BUILD_DIR="./output"`



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

ymake: `export WIKINAME="I love options!"`

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



`VPREFIX` Specify the virtual root of that the default template links to
for the `yiki.css` and the `index.html` files.

ymake: `export VPREFIX="/yiki/"`

GMake: `gmake VPREFIX:="/yiki/"`



`DOMAIN` Specifiy the domain name that your sitemap.xml links to.

ymake: `export DOMAIN="example.com"`

GMake: `gmake DOMAIN:="example.com"`

## 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.