@edoc-space/plugin-changelog

English | Русский

Changelog and release notes component for E-Doc MDX pages.

Use it when a page needs to render release notes from a Markdown or JSON source.

Installation

Install the plugin into the E-Doc local plugin overlay, not into the core application package:

cd local/plugins
yarn add @edoc-space/plugin-changelog

Or with npm:

cd local/plugins
npm install @edoc-space/plugin-changelog

Usage

Put the changelog source into local/storage/edoc/static, for example:

local/storage/edoc/static/changelog.md

Then import the component from an .mdx page:

import { Changelog } from '@edoc-space/plugin-changelog'

<Changelog source="/storage/edoc/static/changelog.md" />

The package imports its CSS from the entrypoint. E-Doc resolves the package from local/plugins/node_modules.

Props

type ChangelogProps = {
  title?: string;
  source?: string;
  entries?: ChangelogItem[];
  repositoryUrl?: string;
  categoryLabels?: Record<string, string>;
};

Supported Source Formats

Markdown changelog:

# Changelog

## 0.1.0 - 2026-07-01

### Added

- Initial public package.

JSON payload with an entries array:

{
  "entries": [
    {
      "title": "First release",
      "version": "0.1.0",
      "date": "2026-07-01",
      "changes": [
        { "category": "added", "text": "Initial public package." }
      ]
    }
  ]
}

Local Development

This repository uses the same package shape as the published npm package:

yarn install
yarn typecheck
yarn build
npm pack --dry-run

Before publishing, make sure the dry-run output contains only dist, README.md, README_RU.md, LICENSE, and package metadata.