1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

Clarify docker command for docs. (#1397)

* Clarify docker command for docs.
* README.md: Add comments.
* docs/_functions/domain/IGNORE_NAME.md: Fix broken YAML
This commit is contained in:
Tom Limoncelli
2022-02-04 16:28:02 -05:00
committed by GitHub
parent 98a951885e
commit d904baa9c5
2 changed files with 4 additions and 1 deletions

View File

@ -170,7 +170,10 @@ docker run --rm -it -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js -v $(pwd)/creds.jso
The documentation can be viewed via Docker:
```
cd docs
docker run --rm -it --volume="$PWD:/srv/jekyll" --volume="$PWD/vendor/bundle:/usr/local/bundle" --env JEKYLL_ENV=production jekyll/jekyll:3.8 jekyll build -V
# Open docs/_site/index.html in your web browser to see the results.
# (Note: The preview isn't perfect. Links that use the site.github.url variable won't work.
```

View File

@ -1,5 +1,5 @@
---
name: `IGNORE_NAME`
name: IGNORE_NAME
parameters:
- pattern
---