Stackhacker UI Changelog Template

Use this template to display GitHub release notes as a changelog with Stackhacker UI, Nuxt MDC, and shadcn-vue components.

• Live demo
• Documentation

Quick Start

pnpm dlx nuxi@latest init my-changelog -t gh:stackhacker-ui/changelog
cd my-changelog
pnpm install
pnpm dev

Config

To customize the GitHub repository that the changelog fetches releases from, update the repository key in app/app.config.ts:

export default defineAppConfig({
  repository: "nuxt/ui", // Change this to your GitHub repository (e.g. "facebook/react")
});

Release notes are fetched from https://ungh.cc/repos/<owner>/<repo>/releases and rendered with Nuxt MDC. GitHub-flavored links in markdown are resolved for the configured default repository in nuxt.config.ts under mdc.remarkPlugins.remark-github.options.repository.

Environment

No environment variables are required for the default changelog. The app reads public GitHub release data through ungh.

Setup

Make sure to install the dependencies:

pnpm install

Development Server

Start the development server on http://localhost:3000:

pnpm dev

To use another port:

pnpm dev --port 4000

Production

Build the application for production:

pnpm build

Locally preview production build:

pnpm preview

Check out the Nuxt deployment documentation for more information.

Quality checks

pnpm lint
pnpm typecheck
pnpm build

Renovate integration

Install Renovate GitHub app on your repository and you are good to go.