Merge pull request #639 from eed3si9n/wip/dollar

Fixes dollar sign

README.md

@@ -86,6 +86,21 @@ Beware that sbt-ghpages interacts badly if your home directory is a git reposito
 - Add last release to "Previous releases" in `src/nanoc/nanoc.yaml`
 - Update `sbtVersion`, `windowsBuild` and `sbtVersionForScalaDoc` in `src/reference/template.properties`
 
+## Dollar sign
+
+Pamflet uses dollar sign (`$`) as the template variable character.
+So if you use it in the document, use need to escape it with backslash: `\$`.
+
+Here's how to check for unescaped dollar signs.
+
+```
+$ brew install ripgrep
+$ rg '^([^\$]*)[^\\]\$([^\$]*)$' -g '*.md' src
+
+src/reference/02-DetailTopics/03-Dependency-Management/04-Proxy-Repositories.md
+79:  export SBT_CREDENTIALS="$HOME/.ivy2/.credentials"
+```
+
 ## Including code examples
 
 To include a validated code examples, create a scripted test under `src/sbt-test`,

src/reference/02-DetailTopics/03-Dependency-Management/04-Proxy-Repositories.md

@@ -76,7 +76,7 @@ This repositories file is all that's required to use a proxy repository.  These
 
 In case you need to define credentials to connect to your proxy repository, define en environment variable `SBT_CREDENTIALS` that points to the file containing your credentials:
 
-  export SBT_CREDENTIALS="$HOME/.ivy2/.credentials"
+  export SBT_CREDENTIALS="\$HOME/.ivy2/.credentials"
 
 with file contents