# eventbus/docs

Congrats, you found the EventBus `docs` repository.

Hosted at [https://git.xarth.tv/pages/eventbus/docs/](https://git.xarth.tv/pages/eventbus/docs/)
as a Github page, the site is generated by [Hugo](https://github.com/gohugoio/hugo), a fast static site generator.

You can update the site through this repository. Hugo is not required to make changes, but if you want to run a local copy of the site you can download hugo for yourself here: https://gohugo.io/getting-started/installing/.

## Contributing

Push your changes up to the master branch and wait about 10 seconds for the site to be updated. The [Jenkins job](https://jenkins-og.xarth.tv/job/eventbus/job/docs/job/master/) 
will automatically build and publish your changes to the docs site.

NOTE: The version of the theme being used is partially broken when using Hugo at a version above 0.54. For this reason, it is recommended that you download version 0.54 of Hugo while performing local development for a more accurate representation of the deployed docs site.


### Updating Site Content

To make changes to site content: update or create new markdown files in the `/content` folder. If you have hugo installed locally, you can create a new file with the following command, which will additionally populate the title, date, and 'draft' flag.

```sh
hugo new my-article.md
```

### Local dev server

To see your changes on your local machine, run:

```sh
make hugo
```

And open http://localhost:1313/pages/eventbus/docs/

Any changes will automatically reflect on the local dev site upon save.
