pidgin/nest

Move build info into a header comment.

2019-08-19, Elliott Sales de Andrade
c3a002e9a2b4
Move build info into a header comment.

No user is ever going to read this, and it's doubtful that any developer
will either once we're sure that deployment is working correctly.

Also, dropped the Hugo version from the comment, since that's part of
the tags.
# 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
To start development server run:
`hugo server -s hugo -D --disableFastRender -v --verboseLog --noHTTPCache --i18n-warnings`
- `--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
## Docker
1. `docker build -t pidgin/nest:latest .`
2. `docker run -it --rm -p 3000:3000 pidgin/nest:latest`
### Formatting
These are some regex's to quickly format templating
| regex | replace |
| -------------------- | -------- |
| `\{\{(\w|\.|\$|\()` | `{{ $1` |
| `\{\{-(\w|\.|$)` | `{{- $1` |
| `("|\w|\.|\))(-)?}}` | `$1 }}` |
## Hugo config
To disable **Copy Code to Clipboard** the `disableInlineCopyToClipBoard` switch
can be used either in **config** `[params]` **or** in the front matter of the
individual page
## Tools
- **Visual Regression**
1. [Run dev server](#Developing-Docs)
1. To run the visual diff tool call `node tools/visual-diff.js` or
`npm run regression`