https://github.com/spekulatius/vuepress-plugin-umami
Umami plugin for VuePress
https://github.com/spekulatius/vuepress-plugin-umami
analytics analytics-tracking google-analytics privacy privacy-protection privacy-tools private tracking tracking-api umami umami-analytics umami-plugin vuepress vuepress-plugin vuepress-site
Last synced: 5 months ago
JSON representation
Umami plugin for VuePress
- Host: GitHub
- URL: https://github.com/spekulatius/vuepress-plugin-umami
- Owner: spekulatius
- License: mit
- Created: 2020-08-30T12:04:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-28T10:44:39.000Z (over 2 years ago)
- Last Synced: 2024-08-08T21:10:43.150Z (about 1 year ago)
- Topics: analytics, analytics-tracking, google-analytics, privacy, privacy-protection, privacy-tools, private, tracking, tracking-api, umami, umami-analytics, umami-plugin, vuepress, vuepress-plugin, vuepress-site
- Language: JavaScript
- Homepage: https://releasecandidate.dev/degoogling-your-analytics-with-umami-and-forge-in-10-minutes
- Size: 89.8 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Umami Analytics Plugin for VuePress
This project helps to integrate [Umami Analytics](https://umami.is/) in your [VuePress](https://vuepress.vuejs.org/) site. Umami is a self-hosted, [privacy-friendly alternative to Google Analytics](https://github.com/spekulatius/awesome-privacy-friendly-web-analytics).
## Why?
Online tracking has become an epidemic eroding our privacy. A very large number of websites collect data using a small number of tools and platforms. This leads to the ability to follow online users and build up detailed profiles. This is a highly undesirable development.
Private and self-hosted solutions such as Umami can help to address the issue. These provide analytics without collecting personalized data and the data stays 100% under your in control.
VuePress is more and more used for developer-related content such as documentation websites. I hope to make a small contribution by allowing and promoting a simple alternative to Google Analytics for this platform.
## Install
For installation instructions on how to get Umami up and running check [this](https://umami.is/docs/install).
To install the VuePress plugin run one of the following commands:
```sh
npm install vuepress-plugin-umami
# or
yarn add vuepress-plugin-umami
```
## Configuration
Add the vuepress plugin in your site or theme config file. The configuration is done as part of the plugin-configuration. Your configuration file is usually located under `.vuepress/config.js`. Extend it with this line:
```js
module.exports = {
plugins: [
'umami': { trackerUrl: 'https://link-to-your-umami-instance.project.com', siteId: 'a9safa7-asfasf-asfasf' }
// other plugins
// ...
]
}
```
You will get parameters required from your Umami instance:
*Please note:* The URL in the configuration shouldn't include `/umami.js`.
For more details on how to work with VuePress plugins check the [official docs](https://vuepress.vuejs.org/plugin/using-a-plugin.html).
## License
This package is release under the MIT license by [Peter Thaleikis](https://peterthaleikis.com).