https://github.com/spekulatius/vuepress-plugin-plausible
VuePress plugin for Plausible.io
https://github.com/spekulatius/vuepress-plugin-plausible
analytics analytics-tracking analyticsjs plausible plausible-analytics vuepress vuepress-plugin
Last synced: about 2 months ago
JSON representation
VuePress plugin for Plausible.io
- Host: GitHub
- URL: https://github.com/spekulatius/vuepress-plugin-plausible
- Owner: spekulatius
- License: mit
- Created: 2020-08-31T12:13:38.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-28T10:43:38.000Z (about 2 years ago)
- Last Synced: 2024-10-07T19:19:00.136Z (9 months ago)
- Topics: analytics, analytics-tracking, analyticsjs, plausible, plausible-analytics, vuepress, vuepress-plugin
- Language: JavaScript
- Homepage: https://releasecandidate.dev
- Size: 11.7 KB
- Stars: 4
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Plausible Analytics Plugin for VuePress
This plugin helps to integrate [Plausible Analytics](https://plausible.io/) in your [VuePress](https://vuepress.vuejs.org/) documentation website. Plausible is a alternative to Google Analytics with a focus on privacy.
There is also a list [privacy-focused tracking solutions](https://github.com/spekulatius/awesome-privacy-friendly-web-analytics).
## Install
To install the VuePress plugin, run one of the following commands:
```sh
npm install vuepress-plugin-plausible
# or
yarn add vuepress-plugin-plausible
```
## 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: {
'plausible': { domain: 'your-domain.com' },
// other plugins
// ...
}
}
```
## Self hosted url
If you are self hosting Plausible, you can use this option
```js
module.exports = {
plugins: {
'plausible': { domain: 'your-domain.com', 'selfHostedUrl': 'your-self-hosted-domain-url' },
// other plugins
// ...
}
}
```
### Outbound link tracking
Plausible can also [track all outbound links](https://plausible.io/docs/outbound-link-click-tracking). To enable outbound link tracking with this extension, do this instead of the above:
```js
module.exports = {
plugins: {
'plausible': { domain: 'your-domain.com', outboundLinkTracking: true },
// other plugins
// ...
}
}
```
For more details on how to work with VuePress plugins, check out the [official docs](https://vuepress.vuejs.org/plugin/using-a-plugin.html).
## License
This package is released under the MIT license by [Peter Thaleikis](https://peterthaleikis.com).