Jekyll::analytics
Webanalytics for Jekyll.
There are many tutorials online to add analytics to Jekyll by extending the template. Jekyll-analytics is here to take care of this. Just install the plugin, configure it and you are done :)
Jekyll-analytics: Webanalytics made easy.
Supported:
Installation
Add this to your Gemfile:
gem 'jekyll-analytics'
Then execute
$ bundle
Or install it yourself
gem install jekyll-analytics
Configuration
Edit _config.yml to use the plugin:
plugins:
- jekyll-analytics
Configure the plugin in _config.yml by adding:
jekyll_analytics:
GoogleAnalytics: # Add, if you want to track with Google Analytics
id: UA-123-456 # Required - replace with your tracking id
anonymizeIp: false # Optional - Default: false - set to true for anonymized tracking
Matomo: # Add, if you want to track with Matomo (former Piwik Analytics)
url: matomo.example.com # Required - url to Matomo installation without trailing /
siteId: "1234" # Required - replace with your Matomo site id (Write id as string)
Piwik: # Add, if you want to track with Piwik
url: piwik.example.com # Required - url to Piwik installation without trailing /
siteId: "1234" # Required - replace with your Piwik site id (Write id as string)
MPulse: # Add if you want to track performance with mPulse
apikey: XXXXX-YYYYY-ZZZZZ-AAAAA-23456 # Required - replace with your mPulse API key
Plausible:
domain: 'example.com' # The domain configured in plausible
source: 'https://plausible.example.com/js/plausible.js' # The source of the javascriptUsage
Tracking will be disabled in development mode. To enable production mode set enviroment variable JEKYLL_ENV=production. Github pages automatically sets JEKYLL_ENV to production. For testing use
$ JEKYLL_ENV=production jekyll serve
Contributing
- Fork it ( https://github.com/hendrikschneider/jekyll-analytics/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
How to add support for a new tracker:
- Create new tracker class in lib/analytics/YourTracker.rb
#initialize and render must be implemented!
class YourTracker
def initialize(config)
#validate config
end
def render
return "Tracking code to insert into html > head"
end
end
- Update README.md