lektor-website/plugins/lektor-google-analytics/index.html

301 lines
9.7 KiB
HTML
Raw Normal View History

2022-02-20 15:15:38 +01:00
<!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">
2022-12-17 10:12:40 +01:00
<link rel="stylesheet" href="../../static/styles.css?h=dff0aaad">
2022-02-20 15:15:38 +01:00
<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 &ndash; 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>
2022-09-13 16:42:43 +02:00
<a href="mailto:k@kmonsoor.com">Khaled Monsoor</a>
2022-02-20 15:15:38 +01:00
</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>
2022-02-24 02:43:35 +01:00
<p>
View <a href="../tags/" class="ref">all tags</a>.
</p>
2022-02-20 15:15:38 +01:00
</div>
<div class="col-sm-9 doc-styling">
<h2>Project Description</h2>
2023-11-11 13:12:23 +01:00
lektor-google-analytics
<br>=======================
<br>
<br>
<br>This plugin adds support for `Google analytics` to `Lektor CMS`.
<br>
<br>Once the plugin is enabled, a ``generate_google_analytics()`` function
<br>is available to be included in target ``template`` which automatically
<br>include Google-Analytics code in final HTML files rendered by
<br>``Lektor``.
<br>
<br>
<br>Basic Usage
<br>-----------
<br>
<br>Enabling the Plugin
<br>~~~~~~~~~~~~~~~~~~~
<br>
<br>To enable the plugin add this to your project file:
<br>
<br>.. code:: ini
<br>
<br> [packages]
<br> lektor-google-analytics = 0.1
<br>
<br>Configuring the Plugin
<br>~~~~~~~~~~~~~~~~~~~~~~
<br>
<br>The plugin needs a config file with your ``Google analytics`` code in
<br>it.
<br>
<br>Just create a file named ``google-analytics.ini`` into ``./configs``
<br>folder in your Lektor projects base directory. And, put the
<br>``GOOGLE_ANALYTICS_ID`` key with target property ID of form
<br>``UA-XXXXXXXX-Y`` which you obtained from:
<br>
<br>.. code:: ini
<br>
<br> GOOGLE_ANALYTICS_ID = UA-XXXXXXXX-Y
<br>
<br>Using in Templates
<br>~~~~~~~~~~~~~~~~~~
<br>
<br>Now you can add a Google analytics code-snippet in your templates by
<br>just calling the ``generate_google_analytics`` function inside its ``&lt;body&gt; &lt;/body&gt;`` tags.
<br>
<br>.. code:: html
<br>
2024-03-27 03:30:41 +01:00
<br> &lt;div class="ga-script"&gt;{{ generate_google_analytics() }}&lt;/div&gt;
<br>
2023-11-11 13:12:23 +01:00
<br>Thats it. All the ``HTML`` files that rendered from that template will
<br>include Google-Analytics code automatically.
<br>
<br>
<br>Advanced
<br>--------
<br>
<br>You can use ``GOOGLE_ANALYTICS_PROPERTY`` property to include your
<br> custom-built Google Analytics tracking code. In that case, your
<br> ``./configs/google-analytics.ini`` will look like this:
<br>
<br>.. code:: ini
<br>
<br> GOOGLE_ANALYTICS_ID = UA-XXXXXXXX-Y
<br> GOOGLE_ANALYTICS_PROPERTY = 'my custom code'
<br>
<br>Dont use this property unless you know what are you doing. By default,
<br>it is set to ``auto``.
<br>
<br>To go deeper than this, please refer to `Google-Analytics
<br>documentation`.
<br>
<br>
<br>-----
<br>
<br>
<br>**Copyright** (c) 2015, Khaled Monsoor
<br>
<br>All rights reserved.
<br>
<br>Licensed under `BSD` license.
2022-02-20 15:15:38 +01:00
<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>
2023-10-25 22:05:34 +02:00
<script type=text/javascript src="../../static/app.js?h=dcf26092" charset="utf-8"></script>
2022-02-20 15:15:38 +01:00
<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>