Contents

# Bhook

Bhook is a static website generator that works off a git repo containing a markdown file based wiki, like for example, the [India Startup Wiki](https://gitlab.com/india-startups/wiki).

I use this to create [HTML versions of the wiki](https://sidu.in/wiki/startups) and of [my essays](https://sidu.in/essays/) that I can publish.

## Installation

Install it yourself as:

    $ gem install bhook

## Usage

Getting help:

	$ bhook --help
	Bhook version 0.1.4
	Usage: bhook --source /source/path --output /output/path
	    -s, --source=SOURCE              Path to version controlled directory containing source md files
	    -o, --output=OUTPUT              Path to directory where output files are to be generated
	    -w, --watch                      Continuously watch the source directory for changes and generate output
	    -v, --verbose                    Print detailed information about files as they are processed
	    -t, --theme=PATH                 Path to directory containing theme files to use when generating html
	        --generate-theme=PATH        Generate a baseline theme that you can then modify to your needs
	        --benchmark                  Run a performance benchmark for the specified source
	    -h, --help                       Prints this help

How I use it:

	➜  essays git:(main) ✗ bhook -s . -o /tmp/out -t /tmp/out/theme -w -v

## Development

1. `git clone --recursive [e-mail]:kaiwren/bhook.git`
2. After checking out the repo, run `bundle install` to install dependencies.
4. Then, run `bundle exec rake` to run the specs and sorbet typechecking. 

## Contributing

Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/kaiwren/bhook.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
bhook-0.1.6	README.md
bhook-0.1.5	README.md
bhook-0.1.4	README.md