# How to Disable the GitHub Star Reminder in Plausible‑Hugo

> Easily disable the GitHub star reminder in Plausible-Hugo by setting gitstar to false in your site configuration. Remove the console prompt for a cleaner visitor experience. Learn how now.

- Repository: [divinerites/plausible-hugo](https://github.com/divinerites/plausible-hugo)
- Tags: how-to-guide
- Published: 2026-02-28

---

**Set `gitstar = false` under `[params.plausible]` in your Hugo site configuration to remove the console message asking visitors to star the repository on GitHub.**

The plausible‑hugo theme by divinerites includes a subtle reminder in the HTML source that encourages visitors to star the project on GitHub. While helpful for the open‑source project, you can cleanly **disable the GitHub star reminder in plausible‑hugo** through a single configuration parameter without editing any theme files.

## How the Star Reminder Is Implemented

The reminder logic resides in [`layouts/partials/plausible_check.html`](https://github.com/divinerites/plausible-hugo/blob/main/layouts/partials/plausible_check.html). According to the divinerites/plausible‑hugo source code, this partial checks the value of `site.Params.plausible.gitstar` when rendering your site.

By default, when the `gitstar` key is missing from your configuration, the partial treats it as **true** and injects an HTML comment into your pages. When you explicitly set this parameter to **false**, the partial skips rendering the reminder entirely.

## Configuration Steps to Disable the Reminder

Add the `gitstar` parameter to your site configuration file. The exact syntax depends on your configuration format.

### Using config.toml

```toml
[params.plausible]
  # … other Plausible‑Hugo settings …

  gitstar = false   # Disable GitHub star reminder

```

### Using config.yaml

```yaml
params:
  plausible:
    # … other Plausible‑Hugo settings …

    gitstar: false   # Disable GitHub star reminder

```

### Using config.json

```json
{
  "params": {
    "plausible": {
      // … other Plausible‑Hugo settings …
      "gitstar": false   // Disable GitHub star reminder
    }
  }
}

```

## Rebuilding Your Site

After updating the configuration, regenerate your site to apply the changes.

```bash
hugo

```

When the build completes, the generated HTML will no longer contain the comment prompting users to star the repository. You can verify this by searching the output in `public/` or viewing the page source in your browser.

## Summary

- The GitHub star reminder is controlled by the `gitstar` parameter in `site.Params.plausible`.
- The logic is implemented in [`layouts/partials/plausible_check.html`](https://github.com/divinerites/plausible-hugo/blob/main/layouts/partials/plausible_check.html), which defaults to showing the reminder when the parameter is undefined.
- Setting `gitstar = false` in your Hugo configuration (TOML, YAML, or JSON) suppresses the reminder without modifying theme files.
- Rebuild your site with `hugo` to apply the change.

## Frequently Asked Questions

### What is the GitHub star reminder in plausible‑hugo?

The reminder is an HTML comment injected by the [`plausible_check.html`](https://github.com/divinerites/plausible-hugo/blob/main/plausible_check.html) partial that appears in the page source code, asking visitors to star the divinerites/plausible‑hugo repository on GitHub. It is enabled by default to support the open‑source project.

### Will disabling the star reminder affect Plausible Analytics tracking?

No. The `gitstar` parameter only controls the display of the GitHub repository link. It does not alter the Plausible Analytics script injection or tracking functionality handled by other partials in the theme.

### Can I disable the reminder for specific pages only?

No. The `site.Params.plausible.gitstar` setting is a site‑wide configuration parameter. The [`plausible_check.html`](https://github.com/divinerites/plausible-hugo/blob/main/plausible_check.html) partial evaluates this global setting during the Hugo build process, applying the same behavior to all generated pages.

### Where can I find documentation about other plausible‑hugo configuration options?

The complete configuration reference is documented in the repository’s [`README.md`](https://github.com/divinerites/plausible-hugo/blob/main/README.md) file on GitHub. This file details all available parameters under `params.plausible`, including domain settings, script sources, and the `gitstar` option.