Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
Changelog.co Technical Documentation

Setting up a custom domain

To set up a custom domain for your changelog ( like changelog.example.com ) follow these steps:

  1. Create a CNAME record to proxy.changelog.co (the person on your team in charge of webhosting will know how to do this)
  2. Email hey@marckohlbrugge.com with the custom domain you'd like to use.
  3. We'll let you know when the custom domain is ready.

Embedding the widget on your site

The widget in action

Changelog.co has a smart widget that informs your customer when there's new content posted since he or she last visited your changelog. A small red badge is shown like you can see above.

To install the widget follow these steps:

1. Add the following code inbetween the <head> and </head> tags:

<script type="text/javascript" src="//changelog.co/widget.js" async></script>
  • Please do not download this script and host it yourself as we might need to change it over time.
  • The src-attribute does not need to include http. Browsers will automatically choose the right protocol (http or https) depending on the page it's called from.

2. Add a link to your changelog anywhere on your page (using a secure https:// link is recommended) and add an attribute called data-changelog-badge. You can leave the value empty. Example:

<a href="https://changelog.betalist.com" data-changelog-badge>Changelog</a>

3. Optionally, you can override the look-and-feel of the badge by adding custom CSS:

<style>
.changelog-badge { color: #23d200 !important; }
</style>

4. Done!

  • After posting an update to your changelog you're considered having seen it, and thus the widget will not show the badge to you. To verify it works correctly you can try visiting the page with the widget using a different browser or in incognito mode. If you see the badge, try visiting your changelog and on the next page load the badge should disappear.

  • If you're having problems with the widget or are unsure it's installed correctly feel free to reach out to us and we'll have a look.

  • If the user has never visited your changelog before, has cookies disabled or is running a browser extension that blocks our widget, then the widget will show the red badge by default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment