https://github.com/ccfenner/material-matomo-plugin

🚧
https://github.com/ccfenner/material-matomo-plugin

mkdocs mkdocs-material mkdocs-plugin

Last synced: 8 days ago
JSON representation

🚧

• Host: GitHub
• URL: https://github.com/ccfenner/material-matomo-plugin
• Owner: CCFenner
• License: isc
• Created: 2024-12-13T07:41:02.000Z (9 days ago)
• Default Branch: main
• Last Pushed: 2024-12-13T07:54:28.000Z (9 days ago)
• Last Synced: 2024-12-13T08:28:05.753Z (9 days ago)
• Topics: mkdocs, mkdocs-material, mkdocs-plugin
• Language: HTML
• Homepage:
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Plausible Analytics for Material

This is forked from [notpushkin/material-plausible-plugin](https://gitlab.com/notpushkin/material-plausible-plugin).

🚧 work in progress 🚧

Matomo is an open-source and privacy-friendly web analytics alternative to Google Analytics.

This plugin implements Matomo support in Material for MkDocs.

## Quick start

1. Install the plugin:

    ```sh

    pip install material-matomo-plugin

    ```

2. Add the following lines to `mkdocs.yml`:

    ```yaml

    plugins:

      - material-matomo

    extra:

      analytics:

        provider: matomo

        domain: example.com

        #: If using custom domain proxy or self-hosting Plausible,

        #: uncomment and specify script path here:

        # src: "https://plausible.example.com/js/plausible.js"

    ```

### Feedback widget

To enable the feedback widget, add the following lines inside the `extra.analytics` block:

```yaml

feedback:

  title: Was this page helpful?

  ratings:

    - icon: material/emoticon-happy-outline

      name: This page was helpful

      data: good

      note: >-

        Thanks for your feedback!

    - icon: material/emoticon-sad-outline

      name: This page could be improved

      data: bad

      note: >-

        Thanks for your feedback! Help us improve this page by

        using our feedback form.

```

Then in your Plausible account, go to your website's settings and visit the

**Goals** section. For each rating defined, click on the **+ Add goal** button,

select **Custom event** as the goal trigger and enter `Feedback: {rating data

value}`.

For example, if you have two ratings – `good` and `bad`, add `Feedback: good`

and `Feedback: bad` goals.

Ratings will be shown in the **Goal Conversions** section at the very bottom of the page, as soon as any are available:



You 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.

### Site search

You can track site search usage, too. Enable the `search` plugin, then in the

**Goals** section, set up a goal named `Search`. On your statistics page, you

can click it in the goals list to see what terms your users are searching for:



## License

`material-plausible-plugin` is distributed under the terms of the [ISC license](https://spdx.org/licenses/ISC.html).