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

GitHub

git clone https://github.com/hang-up/buk.git buk
cd buk
npm install

NPM

npm install buuk

# safely move buuk out of node_modules since it's not supposed to be a dependency.
# then install dependencies
mv node_modules/buuk . && cd buuk  && npm install

(Optional) Version controlling your documents

If you need to version control your documents, you can:

• Fork this repository and then sync it whenever a new release becomes available.
• Change the remote after creating an empty repo on your github account:

git remote set-url origin https://github.com/YOUR OWN USER NAME/buk.git

---

2. Drop your markdown files in static/docs.
3. Update static/manifest.json
4. Finally:

npm run build
# outputted files will be in /dist

---

Viewing the content outputted in dist requires a web server. You set up a quick web server in two easy ways:

1. npm run dev - opens a webserver at localhost:8000
2. Use the local-web-server package:

npm i local-web-server -g
cd dist
ws

Refer to Usage/manifest.json to learn more about file naming conventions.

Documentation - Example

To check out live example which also happen to be the docs, visit: buuk.groundedrob.com

Changelog:

Details changes for each release are documented in the release notes

Licence

MIT