{"_id":"@4lch4/docusaurus-plugin-umami","_rev":"1-7af4b2ec7867b5696f692e6aa3ae163c","name":"@4lch4/docusaurus-plugin-umami","dist-tags":{"latest":"0.1.6"},"versions":{"0.1.6":{"name":"@4lch4/docusaurus-plugin-umami","displayName":"Docusaurus Plugin Umami","version":"0.1.6","description":"A Docusaurus plugin to add support for Umami analytics.","main":"./src/index.js","exports":"./src/index.js","type":"module","license":"MIT","homepage":"https://github.com/4lch4/Docusaurus-Plugin-Umami","scripts":{"pretty":"prettier --write .","lint":"prettier -c .","test":"echo 'There are currently no tests available.'","scan":"snyk monitor && snyk code test"},"publishConfig":{"access":"public"},"engines":{"node":">=10.15.1"},"keywords":["docusaurus","umami"],"repository":{"type":"git","url":"git+ssh://git@github.com/4lch4/4lch4.git"},"author":{"name":"4lch4","email":"hey@4lch4.email","url":"https://4lch4.com"},"bugs":{"url":"https://github.com/4lch4/Docusaurus-Plugin-Umami/issues","email":"bugs@4lch4.email"},"devDependencies":{"prettier":"^2.8.8","snyk":"^1.1177.0"},"dependencies":{"@4lch4/logger":"^1.11.0"},"gitHead":"8fe8be807305f7f87bb43d81f4ef65d7581dcb89","_id":"@4lch4/docusaurus-plugin-umami@0.1.6","_nodeVersion":"18.16.0","_npmVersion":"9.5.1","dist":{"integrity":"sha512-fq8B53xNvmIh3A+/V7Ger4Kfu96JiRRuNSYzlrvTHfnR0eINbLLvcmLlAL78rhYSnToAq1UU87JTfp6hhiAITQ==","shasum":"fb8bc7a5c4ce0fa84ae0a7d9d78a7493b16959dd","tarball":"https://registry.npmjs.org/@4lch4/docusaurus-plugin-umami/-/docusaurus-plugin-umami-0.1.6.tgz","fileCount":5,"unpackedSize":6584,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEcRELfPBDMb4uCU13LFniJL6+1GGnNdP4FMk8wwkZlRAiEAz/+saCRMGb2lSP/iF5IdCCFIdm/CnaquxYP/Bq38Vpk="}]},"_npmUser":{"name":"alcha","email":"npmjs@4lch4.email"},"directories":{},"maintainers":[{"name":"alcha","email":"npmjs@4lch4.email"},{"name":"4lch4-ci","email":"inbox@4lch4.dev"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docusaurus-plugin-umami_0.1.6_1686455369817_0.6503400584471923"},"_hasShrinkwrap":false,"deprecated":"I no longer use this package and have started using other analytics tools. feel free to fork and maintain it yourself."}},"time":{"created":"2023-06-11T03:49:29.740Z","0.1.6":"2023-06-11T03:49:30.009Z","modified":"2023-11-05T19:16:20.731Z"},"maintainers":[{"name":"4lch4-ci","email":"inbox@4lch4.dev"},{"name":"alcha","email":"npmjs@4lch4.email"}],"description":"A Docusaurus plugin to add support for Umami analytics.","homepage":"https://github.com/4lch4/Docusaurus-Plugin-Umami","keywords":["docusaurus","umami"],"repository":{"type":"git","url":"git+ssh://git@github.com/4lch4/4lch4.git"},"author":{"name":"4lch4","email":"hey@4lch4.email","url":"https://4lch4.com"},"bugs":{"url":"https://github.com/4lch4/Docusaurus-Plugin-Umami/issues","email":"bugs@4lch4.email"},"license":"MIT","readme":"# @4lch4/Docusaurus-Plugin-Umami\n\nThis repo is home to a Docusaurus plugin that is my fork of the [`docusaurus-plugin-umami` plugin][0] by [PatelN123][1]. It enables you to use [Umami analytics][2] on a [Docusaurus site][3].\n\n## Usage\n\nTo use the plugin you must first install it, which you can do by running one of the following commands:\n\n```bash\n# npm\nnpm i @4lch4/docusaurus-plugin-umami\n\n# pnpm\npnpm i @4lch4/docusaurus-plugin-umami\n\n# yarn\nyarn add @4lch4/docusaurus-plugin-umami\n```\n\nOnce you have it installed, you'll need to configure it. To do this, open your [`docusaurus.config.js`][4] file and add a `umami` object to the [`themeConfig`][5] like so:\n\n```js\n// docusaurus.config.js\nmodule.exports = {\n  plugins: ['@4lch4/docusaurus-plugin-umami'],\n  themeConfig: {\n    umami: {\n      websiteId: 'websiteId', // Instructions below on how to find this\n      src: 'script src', // Instructions below on how to find this\n    },\n  },\n}\n```\n\n### Getting the Website Id and Script Src\n\n1. Log into your instance of Umami.\n2. In the top right, click on your profile picture and select \"Profile\".\n   - ![Screenshot 0](./img/Screenshot-0.png)\n   - ![Screenshot 1](./img/Screenshot-1.png)\n3. Click on \"Websites\" in the left sidebar.\n   - ![Screenshot 2](./img/Screenshot-2.png)\n4. For the website you want to track, click on the \"Tracking Code\" button.\n   - ![Screenshot 3](./img/Screenshot-3.png)\n5. The `data-website-id` property is what you want for the `websiteId` field and the `src` property is what you want for the `src` field.\n   - ![Screenshot 4](./img/Screenshot-4.png)\n\n[0]: https://github.com/PatelN123/docusaurus-plugin-umami\n[1]: https://github.com/PatelN123\n[2]: https://umami.is\n[3]: https://docusaurus.io\n[4]: https://docusaurus.io/docs/api/docusaurus-config\n[5]: https://docusaurus.io/docs/api/docusaurus-config#themeConfig\n","readmeFilename":"README.md"}