This repository has been archived on 2023-02-03. You can view files and clone it, but cannot push or open issues or pull requests.
autonomic.zone/CONTRIBUTING.md

38 lines
935 B
Markdown
Raw Normal View History

2017-10-04 14:07:32 +00:00
# Contributing
## What Is Jekyll
2017-10-04 14:07:32 +00:00
For those unfamiliar with how Jekyll works, check out [jekyll.rb] for all the
details, or read up on the basics of [front matter], [writing posts] and
[creating pages].
[jekyll.rb]: https://jekyllrb.com/
[front matter]: https://jekyllrb.com/docs/frontmatter/
[writing posts]: https://jekyllrb.com/docs/posts/
[creating pages]: https://jekyllrb.com/docs/pages/
## Hack On It
2017-10-04 14:07:32 +00:00
The only prerequisite is [Docker](https://www.docker.com/). If you're on Debian, installing is easy.
2017-10-04 14:07:32 +00:00
```bash
$ curl -fsSL https://get.docker.com -o get-docker.sh # have a look if you want
$ sh get-docker.sh
2017-10-04 14:07:32 +00:00
```
Fire up the container with the following.
2017-10-04 14:07:32 +00:00
```bash
$ make dockerserver
2017-10-04 14:07:32 +00:00
```
Then visit the locally running website.
2017-10-04 14:07:32 +00:00
> http://localhost:4000
2017-10-04 14:07:32 +00:00
Then you can edit the files as normal and reload the page.
2017-10-04 14:07:32 +00:00
## Notes
2017-10-04 14:07:32 +00:00
1. For configuration, please note, we now use a `dev` environment config file: `_config_dev.yml`