https://github.com/pradel/docusaurus-plugin-fathom
Fathom analytics plugin for Docusaurus
https://github.com/pradel/docusaurus-plugin-fathom
docusaurus docusaurus-plugin fathom fathom-analytics
Last synced: 3 months ago
JSON representation
Fathom analytics plugin for Docusaurus
- Host: GitHub
- URL: https://github.com/pradel/docusaurus-plugin-fathom
- Owner: pradel
- License: mit
- Created: 2020-05-09T15:33:24.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-06T17:31:23.000Z (over 1 year ago)
- Last Synced: 2025-03-28T18:11:38.468Z (4 months ago)
- Topics: docusaurus, docusaurus-plugin, fathom, fathom-analytics
- Language: JavaScript
- Homepage: https://usefathom.com/ref/ZB4OSQ
- Size: 5.86 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docusaurus-plugin-fathom
[Fathom](https://usefathom.com/ref/ZB4OSQ) analytics plugin for [Docusaurus v2 and v3](https://github.com/facebook/docusaurus).
> 🔥 Fathom is cookie-free, GDPR compliant, privacy-first website analytics software. Get $10 off your first invoice and a 7-day free trial when you use this URL: https://usefathom.com/ref/ZB4OSQ. 🔥
## Installation
Run the following command to install docusaurus-plugin-fathom in your project:
```sh
# With npm
npm install docusaurus-plugin-fathom --save
# With yarn
yarn add docusaurus-plugin-fathom
# With pnpm
pnpm add docusaurus-plugin-fathom
```
## Configuration
Edit the configuration in your site's `docusaurus.config.js` file:
```js
// docusaurus.config.js
module.exports = {
plugins: [require.resolve('docusaurus-plugin-fathom')],
themeConfig: {
fathomAnalytics: {
siteId: 'MY_FATHOM_CODE',
},
},
};
```
Note: tracking is enabled only on production mode