Openchangelog

Transform your changelog Markdown files to beautiful product updates

Website · Docs · Get Started · Demo

Openchangelog takes your Changelog, hosted on GitHub, GitLab or locally and renders it as a beautiful Changelog Website. - Full Text Search - Password Protection - Analytics - Dark, Light and System themes - Automatic RSS feed - Colorful Tags - Supports keep a changelog CHANGELOG.md format or one Markdown file per release - Next.js embed - Various integrations, open an issue to request a new integration

Quickstart

Create an openchangelog.yml config file, from the sample openchangelog.example.yml. For more configuration settings visit our Docs.

docker run -v ./openchangelog.yml:/etc/openchangelog.yml:ro -v ./release-notes:/release-notes -p 6001:6001 ghcr.io/jonashiltl/openchangelog:0.8.0

Or

services:
  openchangelog:
    image: "ghcr.io/jonashiltl/openchangelog:0.8.0"
    ports:
      - "6001:6001"
    volumes:
      - ./release-notes:/release-notes
      - type: bind
        source: openchangelog.yml
        target: /etc/openchangelog.yml

Once deployed, your changelog will be available at http://localhost:6001.