<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<link rel="stylesheet" href="../../static/styles.css?h=ae0cc228">
<link rel="stylesheet" href="../../static/pygments.css">
<link rel="shortcut icon" href="../../static/favicon.png?h=fa09bedd">
<title> | Lektor Static Content Management System</title>
</head>
<body class="default">
<nav class="navbar navbar-inverse navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed"
data-toggle="collapse" data-target="#navbar"
aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../">Lektor</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../../downloads/">Download</a></li>
<li><a href="../../docs/">Documentation</a></li>
<li><a href="../../showcase/">Showcase</a></li>
<li class="active"><a href="../">Plugins</a></li>
<li><a href="../../community/">Community</a></li>
<li><a href="../../blog/">Blog</a></li>
</ul>
</div>
</div>
</nav>
<div class="body-wrapper">
<div class="page-banner page-banner-300" style="background-image: url(../header.jpg)"></div>
<div class="container">
<!-- Place this tag in your head or just before your close body tag. -->
<div class="plugin">
<div class="row">
<div class="col-sm-12">
<h1>Plugin – lektor-google-analytics 0.1.3</h1>
</div>
</div>
<div class="row">
<div class="col-sm-1"></div>
<div class="col-sm-11">
<p>Adds support for Google analytics to Lektor CMS<p>
</div>
</div>
<div class="row">
<div class="col-sm-3 plugin-margin">
<h4>Project links</h4>
<ul class="tree-nav">
<li><a href="http://github.com/kmonsoor/lektor-google-analytics" class="ext">Homepage</a></li>
</ul>
<div class="separator">
<h4>GitHub Statistics</h4>
</div>
<ul class="button-nav">
<li><p><a class="github-button" href="http://github.com/kmonsoor/lektor-google-analytics" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star lektor-google-analytics on GitHub" target="_blank">Star</a></p></li>
<li><p><a class="github-button" href="http://github.com/kmonsoor/lektor-google-analytics/fork" data-icon="octicon-repo-forked" data-show-count="true" data-size="large" data-show="true" aria-label="Open Issues" target="_blank">Fork</a></p></li>
<li><p><a class="github-button" href="http://github.com/kmonsoor/lektor-google-analytics/issues" data-icon="octicon-issue-opened" data-show-count="true" data-size="large" data-show="true" aria-label="Open Issues" target="_blank">Open Issues</a></p></li>
</ul>
<div class="separator">
<h4>Meta</h4>
</div>
<p><strong>Version:</strong> 0.1.3</p>
<p><strong>Author:</strong>
<a href = "mailto:k@kmonsoor.com">Khaled Monsoor</a>
</p>
<div class="separator">
<h4>Tags</h4>
</div>
<a href="../tag/analytics/">analytics</a>,
<a href="../tag/Google-Analytics/">Google Analytics</a>,
<a href="../tag/Jinja-globals/">Jinja globals</a>,
and
<a href="../tag/setup-env/">setup-env</a>
<p>
View <a href="../tags/" class="ref">all tags</a>.
</p>
</div>
<div class="col-sm-9 doc-styling">
<h2>Project Description</h2>
<p>This plugin adds support for <cite>Google analytics</cite> to <cite>Lektor CMS</cite>.</p>
<p>Once the plugin is enabled, a <span class="docutils literal">generate_google_analytics()</span> function
is available to be included in target <span class="docutils literal">template</span> which automatically
include Google-Analytics code in final HTML files rendered by
<span class="docutils literal">Lektor</span>.</p>
<section id="basic-usage">
<h2>Basic Usage</h2>
<section id="enabling-the-plugin">
<h3>Enabling the Plugin</h3>
<p>To enable the plugin add this to your project file:</p>
<pre><code><span class="k">[packages]</span><span class="w">
</span><span class="na">lektor-google-analytics</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><s>0.1</s></code></pre>
</section>
<section id="configuring-the-plugin">
<h3>Configuring the Plugin</h3>
<p>The plugin needs a config file with your <span class="docutils literal">Google analytics</span> code in
it.</p>
<p>Just create a file named <span class="docutils literal"><span class="pre">google-analytics.ini</span></span> into <span class="docutils literal">./configs</span>
folder in your Lektor project’s base directory. And, put the
<span class="docutils literal">GOOGLE_ANALYTICS_ID</span> key with target property ID of form
<span class="docutils literal"><span class="pre">UA-XXXXXXXX-Y</span></span> which you obtained from:</p>
<pre><code><span class="na">GOOGLE_ANALYTICS_ID</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><s>UA-XXXXXXXX-Y</s></code></pre>
</section>
<section id="using-in-templates">
<h3>Using in Templates</h3>
<p>Now you can add a Google analytics code-snippet in your templates by
just calling the <span class="docutils literal">generate_google_analytics</span> function inside its <span class="docutils literal"><body> </body></span> tags.</p>
<pre><code><span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><s>"ga-script"</s><span class="p">></span>{{ generate_google_analytics() }}<span class="p"></</span><span class="nt">div</span><span class="p">></span></code></pre>
<p>That’s it. All the <span class="docutils literal">HTML</span> files that rendered from that template will
include Google-Analytics code automatically.</p>
</section>
</section>
<section id="advanced">
<h2>Advanced</h2>
<dl class="simple">
<dt>You can use <span class="docutils literal">GOOGLE_ANALYTICS_PROPERTY</span> property to include your</dt>
<dd><p>custom-built Google Analytics tracking code. In that case, your
<span class="docutils literal"><span class="pre">./configs/google-analytics.ini</span></span> will look like this:</p>
</dd>
</dl>
<pre><code><span class="na">GOOGLE_ANALYTICS_ID</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><s>UA-XXXXXXXX-Y</s><span class="w">
</span><span class="na">GOOGLE_ANALYTICS_PROPERTY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><s>'my custom code'</s></code></pre>
<p>Don’t use this property unless you know what are you doing. By default,
it is set to <span class="docutils literal">auto</span>.</p>
<p>To go deeper than this, please refer to <cite>Google-Analytics
documentation</cite>.</p>
<hr class="docutils">
<p><strong>Copyright</strong> (c) 2015, Khaled Monsoor</p>
<p>All rights reserved.</p>
<p>Licensed under <cite>BSD</cite> license.</p>
</section>
<div class="comment-box">
<h2>Comments</h2>
<div id="disqus_thread"></div>
<script>
var disqus_config = function() { this.page.identifier = "/plugins/lektor-google-analytics"; this.page.url = "https://www.getlektor.com/plugins/lektor-google-analytics/"; };
(function() {
var d = document, s = d.createElement('script');
s.src = '//lektordocumentation.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>
Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript"
rel="nofollow">comments powered by Disqus.</a>
</noscript>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="bottomsummary">
<div class="container">
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-4 icon-bar">
<a href="https://github.com/lektor/lektor/" title="Lektor on GitHub"
><i class="fa fa-github"></i></a>
<a href="https://github.com/lektor/lektor/issues/" title="Report Issues for Lektor"
><i class="fa fa-bug"></i></a>
<a href="https://twitter.com/getlektor" title="Find Lektor on Twitter"
><i class="fa fa-twitter"></i></a>
<a href="https://gitter.im/lektor/lektor" title="Chat on Gitter"
><i class="fa fa-comment"></i></a>
<a href="https://github.com/lektor/lektor-website/tree/master/content/plugins/lektor-google-analytics/contents.lr" title="View source for this page"><i class="fa fa-code"></i></a>
</div>
<div class="col-sm-8">
<a href="../../license/">License & Copyright</a> •
<a href="../../contact/">Contact</a> •
Made with <i class="fa fa-fw fa-heart" title="Heart"><span hidden>Heart</span></i> in Carinthia
</div>
</div>
</div>
</footer>
<script type=text/javascript src="../../static/app.js?h=bb1b933a" charset="utf-8"></script>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'lektor/lektor',
activationElement: null
};
document.write('<button class="js-gitter-toggle-chat-button">Toggle Chat</button>');
var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
if (dnt != "1" && dnt != "yes") {
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', 'UA-70822533-1', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
} else {
console.debug("Respecting Do-Not-Track, not running analytics.");
}
</script>
<script async src='https://www.google-analytics.com/analytics.js'></script>
<script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
</body>
</html>