From 1a844fb5f67dfef3d9020ec944d91466d5a90f03 Mon Sep 17 00:00:00 2001 From: Eugene Yokota Date: Wed, 7 Mar 2018 18:59:12 -0500 Subject: [PATCH] Fixes dollar sign Fixes #630 --- README.md | 15 +++++++++++++++ .../04-Proxy-Repositories.md | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 698452dea..218ab5184 100644 --- a/README.md +++ b/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`, diff --git a/src/reference/02-DetailTopics/03-Dependency-Management/04-Proxy-Repositories.md b/src/reference/02-DetailTopics/03-Dependency-Management/04-Proxy-Repositories.md index 368f91723..16ba604af 100644 --- a/src/reference/02-DetailTopics/03-Dependency-Management/04-Proxy-Repositories.md +++ b/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