Sharing

Share your published changelogs on a hosted page, inside your product, or from your README. Open a repository and select Sharing to manage these options. For a live example, visit KittyLog's public changelog.

Hosted URL & Visibility

Every plan includes a hosted page at kittylog.app/c/owner/repo. Enable Hosted URL visibility in the Sharing tab so anyone with the link can read your published changelogs. Drafts stay private.

Hosted URL visibility and Custom domain visibility are separate controls. Turning off one does not turn off the other. These settings control access to the changelog, independently of your GitHub repository's visibility.

The hosted URL and custom domain each have their own visibility switch.

Embeddable Widget

In Sharing, find Embed widget and copy the Embed code into your website's HTML. It adds a floating changelog badge so readers can open updates without leaving your product. No build step is required.

Keep Hosted URL visibility enabled: the widget reads your hosted page. Use the preview in Sharing to check the published content before adding the snippet to your site. The default theme follows the reader's system preference; set data-theme to light or dark in the snippet to choose a fixed theme.

Available on every plan. The Free widget includes KittyLog branding; Plus and higher remove the widget branding.

Copy your repository’s generated snippet from Sharing into your website’s HTML.
The open widget on an example site. This Free-plan example includes the KittyLog footer.

README Badge

In Sharing, choose a badge style and copy the generated Markdown or HTML into your README. The badge links readers to your changelog; it does not write release notes into your repository. To keep a CHANGELOG.md file updated, use CHANGELOG.md sync.

Vanity Links

Plus, Pro, and Business include unlimited vanity links. Create a short URL such as kittylog.app/your-project in the Sharing tab, then use it wherever you link to your hosted page. Hosted URL visibility must be enabled for readers to open the link.

RSS Feed

Every plan includes an RSS feed. On your public changelog, use the RSS link or choose RSS Feed from its menu, then copy that URL into your feed reader. Some readers can also discover the feed when you paste the hosted page URL.

The feed address uses your GitHub owner and repository name:

https://api.kittylog.app/api/v1/changelogs/public/OWNER/REPO/rss

Keep Hosted URL visibility enabled, including when you share a custom domain. The feed includes published entries only, and readers do not need a KittyLog account.

Updates can take a few minutes to appear because the feed is cached and each feed reader checks on its own schedule.

Published Update Not Visible?

  • Confirm the entry is published in the Changelogs tab. Drafts can be visible to you as the owner while remaining hidden from other readers.
  • Enable Hosted URL visibility for hosted links, vanity links, the widget, and RSS. A custom domain uses its separate Custom domain visibility control.
  • For a custom domain, also check DNS verification and SSL setup.
  • Open the page in a signed-out or private browser window to check what a reader sees.

To publish at an address such as changelog.example.com, follow the custom-domain setup guide.