From fa09e20d9aa5fd81fa3a6e40ea6d0a52933ce2fc Mon Sep 17 00:00:00 2001 From: Cameron Moore Date: Thu, 15 Dec 2016 10:39:29 -0600 Subject: [PATCH] docs: Fix Ref and RelRef syntax Fixes #2793 --- docs/content/templates/variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/templates/variables.md b/docs/content/templates/variables.md index 8fd653211..db00ebcd5 100644 --- a/docs/content/templates/variables.md +++ b/docs/content/templates/variables.md @@ -56,9 +56,9 @@ matter, content or derived from file location. **.RSSLink** Link to the taxonomies' RSS link.
**.RawContent** Raw Markdown content without the metadata header. Useful with [remarkjs.com](http://remarkjs.com)
**.ReadingTime** The estimated time it takes to read the content in minutes.
-**.Ref(ref)** Returns the permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.
+**.Ref** Returns the permalink for a given reference. Example: `.Ref "sample.md"`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.
**.RelPermalink** The Relative permanent link for this page.
-**.RelRef(ref)** Returns the relative permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments.
+**.RelRef** Returns the relative permalink for a given reference. Example: `RelRef "sample.md"`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments.
**.Section** The [section](/content/sections/) this content belongs to.
**.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.
**.Summary** A generated summary of the content for easily showing a snippet in a summary view. Note that the breakpoint can be set manually by inserting <!--more--> at the appropriate place in the content page. See [Summaries](/content/summaries/) for more details.