From: Bjørn Erik Pedersen Date: Mon, 25 Sep 2017 07:02:34 +0000 (+0200) Subject: Merge commit '30694a133a88d5f76a51d0372646e10cbeca7691' X-Git-Tag: v0.28~5 X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=23ba0edf7197c823b5f6c81a1e05544e4fa74c99;p=brevno-suite%2Fhugo Merge commit '30694a133a88d5f76a51d0372646e10cbeca7691' --- 23ba0edf7197c823b5f6c81a1e05544e4fa74c99 diff --cc docs/content/templates/internal.md index 20390c2f,00000000..6f8d4e86 mode 100644,000000..100644 --- a/docs/content/templates/internal.md +++ b/docs/content/templates/internal.md @@@ -1,131 -1,0 +1,133 @@@ +--- +title: Internal Templates +linktitle: Internal Templates +description: Hugo ships with a group of boilerplate templates that cover the most common use cases for static websites. +date: 2017-03-06 +publishdate: 2017-03-06 +lastmod: 2017-03-06 +categories: [templates] +keywords: [internal, analytics,] +menu: + docs: + parent: "templates" + weight: 168 +weight: 168 +sections_weight: 168 +draft: false +aliases: [] +toc: true +wip: true +--- + + +{{% warning %}} +While the following internal templates are called similar to partials, they do *not* observe the partial template lookup order. +{{% /warning %}} + +## Google Analytics + +Hugo ships with internal templates for Google Analytics tracking, including both synchronous and asynchronous tracking codes. + +### Configure Google Analytics + +Provide your tracking id in your configuration file: + +``` +googleAnalytics = "UA-123-45" +``` + +``` +googleAnalytics: "UA-123-45" +``` + +### Use the Google Analytics Template + +You can then include the Google Analytics internal template: + +``` +{{ template "_internal/google_analytics.html" . }} +``` + + +``` +{{ template "_internal/google_analytics_async.html" . }} +``` + +## Disqus + +Hugo also ships with an internal template for [Disqus comments][disqus], a popular commenting system for both static and dynamic websites. In order to effectively use Disqus, you will need to secure a Disqus "shortname" by [signing up for the free service][disqussignup]. + +### Configure Disqus + +To use Hugo's Disqus template, you first need to set a single value in your site's `config.toml` or `config.yml`: + +``` +disqusShortname = "yourdiscussshortname" +``` + +``` +disqusShortname: "yourdiscussshortname" +``` + +You also have the option to set the following in the front matter for a given piece of content: + +* `disqus_identifier` +* `disqus_title` +* `disqus_url` + +### Use the Disqus Template + +To add Disqus, include the following line in templates where you want your comments to appear: + +``` +{{ template "_internal/disqus.html" . }} +``` + +### Conditional Loading of Disqus Comments + +Users have noticed that enabling Disqus comments when running the Hugo web server on `localhost` (i.e. via `hugo server`) causes the creation of unwanted discussions on the associated Disqus account. + +You can create the following `layouts/partials/disqus.html`: + +{{< code file="layouts/partials/disqus.html" download="disqus.html" >}} +
+ + +comments powered by Disqus +{{< /code >}} + +The `if` statement skips the initialization of the Disqus comment injection when you are running on `localhost`. + +You can then render your custom Disqus partial template as follows: + +``` +{{ partial "disqus.html" . }} +``` + +## The Internal Templates + +* `_internal/disqus.html` +* `_internal/google_news.html` +* `_internal/google_analytics.html` +* `_internal/google_analytics_async.html` +* `_internal/opengraph.html` +* `_internal/pagination.html` +* `_internal/schema.html` +* `_internal/twitter_cards.html` + ++[disqus]: https://disqus.com ++[disqussignup]: https://disqus.com/profile/signup/