Guide · Docusaurus

Add a changelog and feedback widget to Docusaurus

Docusaurus sites usually keep release notes in a blog folder or a CHANGELOG.md that few users ever open. ShipLog gives you a hosted changelog and a feedback board, plus a small widget that shows your latest updates in a What's New tab on every page of your docs. The widget is one plain JavaScript file under 20KB gzipped, it renders in a shadow root where your theme's CSS can't reach it, and it works on the free plan.

Install

Create a client module that loads the widget script once and calls init after it loads.

// src/shiplog.js
if (typeof window !== "undefined" && !window.__shiplogLoaded) {
  window.__shiplogLoaded = true;
  const s = document.createElement("script");
  s.src = "https://app.shiplog.ca/widget/shiplog-widget.js";
  s.onload = () => window.ShipLog.init({ projectSlug: "yourapp" });
  document.body.appendChild(s);
}

Then register it in docusaurus.config.js with clientModules: [require.resolve("./src/shiplog.js")]. Replace yourapp with the project slug from your ShipLog settings. The slug is public, so there is no key to hide.

Themes, the slide-out panel and the other options are in the widget reference, with a live demo.

Start free with one project, 10 changelog entries and 10 feedback items, and move to Captain at $9/mo per project when you need more.

Get started free

Other install guides