{"id":22911119,"url":"https://github.com/ccfenner/material-matomo-plugin","last_synced_at":"2025-04-01T10:45:54.185Z","repository":{"id":267917686,"uuid":"902751896","full_name":"CCFenner/material-matomo-plugin","owner":"CCFenner","description":"🚧","archived":false,"fork":false,"pushed_at":"2024-12-13T07:54:28.000Z","size":160,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T10:45:50.403Z","etag":null,"topics":["mkdocs","mkdocs-material","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CCFenner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-13T07:41:02.000Z","updated_at":"2024-12-13T08:00:39.000Z","dependencies_parsed_at":"2024-12-13T08:38:11.875Z","dependency_job_id":null,"html_url":"https://github.com/CCFenner/material-matomo-plugin","commit_stats":null,"previous_names":["ccfenner/material-matomo-plugin"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CCFenner%2Fmaterial-matomo-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CCFenner%2Fmaterial-matomo-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CCFenner%2Fmaterial-matomo-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CCFenner%2Fmaterial-matomo-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CCFenner","download_url":"https://codeload.github.com/CCFenner/material-matomo-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246628421,"owners_count":20808106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-material","mkdocs-plugin"],"created_at":"2024-12-14T04:14:36.089Z","updated_at":"2025-04-01T10:45:54.165Z","avatar_url":"https://github.com/CCFenner.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Plausible Analytics for Material\n\nThis is forked from [notpushkin/material-plausible-plugin](https://gitlab.com/notpushkin/material-plausible-plugin).\n\n🚧 work in progress 🚧\n\nMatomo is an open-source and privacy-friendly web analytics alternative to Google Analytics.\n\nThis plugin implements Matomo support in Material for MkDocs.\n\n## Quick start\n\n1. Install the plugin:\n\n    ```sh\n    pip install material-matomo-plugin\n    ```\n\n2. Add the following lines to `mkdocs.yml`:\n\n    ```yaml\n    plugins:\n      - material-matomo\n\n    extra:\n      analytics:\n        provider: matomo\n        domain: example.com\n\n        #: If using custom domain proxy or self-hosting Plausible,\n        #: uncomment and specify script path here:\n        # src: \"https://plausible.example.com/js/plausible.js\"\n    ```\n\n### Feedback widget\n\nTo enable the feedback widget, add the following lines inside the `extra.analytics` block:\n\n```yaml\nfeedback:\n  title: Was this page helpful?\n  ratings:\n    - icon: material/emoticon-happy-outline\n      name: This page was helpful\n      data: good\n      note: \u003e-\n        Thanks for your feedback!\n\n    - icon: material/emoticon-sad-outline\n      name: This page could be improved\n      data: bad\n      note: \u003e-\n        Thanks for your feedback! Help us improve this page by\n        using our \u003ca href=\"...\" target=\"_blank\" rel=\"noopener\"\u003efeedback form\u003c/a\u003e.\n```\n\nThen in your Plausible account, go to your website's settings and visit the\n**Goals** section. For each rating defined, click on the **+ Add goal** button,\nselect **Custom event** as the goal trigger and enter `Feedback: {rating data\nvalue}`.\n\nFor example, if you have two ratings – `good` and `bad`, add `Feedback: good`\nand `Feedback: bad` goals.\n\nRatings will be shown in the **Goal Conversions** section at the very bottom of the page, as soon as any are available:\n\n\u003cimg width=\"449\" alt=\"image\" src=\"https://user-images.githubusercontent.com/1298948/211634195-b0131d54-cd5f-49d6-9a3d-85bdb4c493fc.png\"\u003e\n\nYou can click on a specific “goal” to filter your dashboard by it. For example, if you filter by the `Feedback: bad` goal, you can see which pages need the most attention in the **Top Pages** section.\n\n### Site search\n\nYou can track site search usage, too. Enable the `search` plugin, then in the\n**Goals** section, set up a goal named `Search`. On your statistics page, you\ncan click it in the goals list to see what terms your users are searching for:\n\n\u003cimg width=\"444\" alt=\"image\" src=\"/images/goal-search.png\" alt=\"Search goal expanded\"\u003e\n\n## License\n\n`material-plausible-plugin` is distributed under the terms of the [ISC license](https://spdx.org/licenses/ISC.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccfenner%2Fmaterial-matomo-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fccfenner%2Fmaterial-matomo-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccfenner%2Fmaterial-matomo-plugin/lists"}