Skip to content

vuesence/release-timeline

Repository files navigation

GitHub release timeline visualization

Visualize releases of any GitHub repository on a timeline, with information about commits and pull requests.

Perfectly embeds in VitePress and can also be plugged into any HTML page as a Web component or micro-frontend. Can be a good replacement for changelog in the project's technical documentation, automating description of changes and making tracking them convenient for users.


Demo

You can specify any repository via the selection in the upper left corner

Documentation

Installation

pnpm add release-timeline
  • In Vue 3 project:
<script setup>
import { ReleaseTimeline, DefaultOptions as options } from "release-timeline";
import "release-timeline/dist/style.css";
import "release-timeline/dist/animated-background.css";

options.github.owner = "vuesence";
options.github.repo = "release-timeline";
</script>

<ReleaseTimeline :options="options" />
  • For other types of installations, please refer to the documentation

Contributions

If you have any ideas for improving release-timeline, feel free to open an issue or pull request.