Documentation

Everything you need to get started with AnnounceHQ.

Quick Start

1. Create an Account

2. Create a Project

Click "New Project" and give it a name. Choose a slug that will be part of your changelog URL (e.g., myapp.announcehq.com).

3. Write Your First Entry

Click "New Entry" and write your update in Markdown. Choose a category (New, Improved, or Fixed) and hit Publish.

4. Share Your Changelog

Your changelog is live! Share the URL with users or install the widget on your website.

Widget Installation

Add the changelog widget to your website with a single script tag:

<script
  src="https://announcehq.com/widget.js"
  data-project="your-project-slug"
  data-theme="auto"
  data-position="bottom-right"
  async
></script>

data-project (required): Your project slug

data-theme: "auto", "light", or "dark"

data-position: "bottom-right" or "bottom-left"

data-limit: Number of entries to show (1-20, default 5)

Frequently Asked Questions

How do I create my first changelog?

Sign up for a free account, create a new project, and write your first entry. Click "Publish" when ready. Your changelog is immediately available at yourproject.announcehq.com.

How do I install the widget?

Go to your project settings and copy the widget code. Paste it before the closing </body> tag on your website. The widget will appear automatically.

How do email notifications work?

When you publish a new entry, all confirmed subscribers receive an email notification. Users subscribe via the form on your changelog page. They must confirm their email before receiving updates.

Can I use my own domain?

Yes, on the Pro plan you can use a custom domain like changelog.yourdomain.com. Add a CNAME record pointing to cname.announcehq.com and configure it in your project settings.

What markdown features are supported?

Full GitHub-flavored Markdown including headers, bold, italic, links, images, code blocks with syntax highlighting, lists, and blockquotes.

Can I have multiple team members?

Team collaboration is available on the Team plan. You can invite team members and manage permissions for who can create, edit, and publish entries.

Is there an API?

A public API endpoint is available for reading published entries: /api/widget/{project-slug}. Full API access for creating and managing entries is available on the Team plan.

How do I remove AnnounceHQ branding?

Upgrade to the Pro plan to remove the "Powered by AnnounceHQ" badge from your changelog page and widget.

Can I import existing changelogs?

Yes! Connect your GitHub repo and we'll automatically import releases as changelog entries. You can also enable AI-powered summaries that analyse your commits and generate professional release notes.

What happens if I downgrade from Pro?

Your changelog remains accessible. Custom domain and branding removal features will be disabled. If you exceed free tier limits, you'll need to remove projects or subscribers.

Need Help?

Can't find what you're looking for? We're here to help.

Contact Support