<p align="center"><img src="http://groundedrob.com/images/projects/buk.png" height='250px'></p>

## About Bük
> A markdown based documentation generator.

Bük is a fast and simple markdown based static site generator geared towards documentation.

Simply drop in your .md files in a folder, update manifest.json and you get a blazing fast wiki with an integrated fuzzy search feature.

## Quickstart

1) Get Bük
> ##### Git Clone
```
git clone https://github.com/hang-up/buk.git buk
cd buk
npm install
```

> ##### NPM
Alternatively, use NPM.

```
npm install buuk

# install dependencies
npm install
```
---

2) Drop your markdown files in `docs`.
3) Update `manifest.json`
4) `npm run build` or `npm run pwa`


## Documentation - Example
To check out live example which also happen to be the docs, visit: [buuk.groundedrob.com](https://buuk.groundedrob.com)

## Changelog:
Details changes for each release are documented in the [release notes](https://github.com/hang-up/buk/releases)

### Licence
MIT


