pidgin/nest

60c0632cc2c1
[minor] Adds docker documentation to readme
# Pidgin Nest
The place we like call home.
## Table of contents
- [Community](community.md)
- [Contributing](contributing.md)
- [Design Guidelines](design-guidelines.md)
- [Development FAQ](development-faq.md)
- [Release Process](release-process.md)
## Dependencies
This project uses [hugo](https://gohugo.io/), get it [here](https://gohugo.io/getting-started/installing/)
## Developing Docs
1. To start devleopment server run: `hugo server -D --disableFastRender -v --verboseLog --noHTTPCache`
- `--disableFastRender`. Disabling fast render is needed because hugo starts to ignore new content in the data dir
- `-v --verboseLog`. Better logging and debugging experience
- `--noHTTPCache`. To prevent caching issues with
## Docker
1. `docker build -t pidgin/nest:latest .`
2. `docker run -it --rm -p 3000:3000 pidgin/nest:latest`
### Formatting
These are some regexes to quickly format templating
| regex | replace |
| -------------------- | -------- |
| `\{\{(\w|\.|\$|\()` | `{{ $1` |
| `\{\{-(\w|\.|$)` | `{{- $1` |
| `("|\w|\.|\))(-)?}}` | `$1 }}` |