Version 5 🎉

- upgrade React Activity Calendar to v3
- migrate to pure ESM package
- remove default export
- remove totalCount property
- all breaking changes from React Activity Calendar v3

Author: grubersjoe

.husky/pre-commit .husky/pre-push.husky/pre-commit renamed to .husky/pre-push

@@ -3,16 +3,19 @@
 [![CI](https://github.com/grubersjoe/react-github-calendar/actions/workflows/test.yml/badge.svg)](https://github.com/grubersjoe/react-github-calendar/actions/workflows/test.yml)
 [![npm version](https://badge.fury.io/js/react-github-calendar.svg)](https://www.npmjs.com/package/react-github-calendar)
 
-A React component to display a GitHub contributions graph based on
+A React component to display a GitHub contributions calendar based on
 [`react-activity-calendar`](https://github.com/grubersjoe/react-activity-calendar) and
 [`github-contributions-api`](https://github.com/grubersjoe/github-contributions-api).
 
+**Version 5** has been released 🎉<br>See the list of
+[breaking changes](https://github.com/grubersjoe/react-activity-calendar/releases/tag/v5.0).
+
 ![Screenshot](preview.png)
 
 [Demo and documentation](https://grubersjoe.github.io/react-github-calendar/)
 
 <a href="https://www.buymeacoffee.com/grubersjoe">
-  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 40px;" >
+  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 32px;" >
 </a>
 
 ## Installation

README.md

@@ -3,20 +3,23 @@
   "scripts": {
     "build": "tsc && vite build",
     "dev": "vite",
+    "prebuild": "./scripts/docgen.sh",
     "preview": "vite preview"
   },
   "dependencies": {
     "react-error-boundary": "^6.0.0",
     "react-github-btn": "^1.4.0",
     "react-github-calendar": "link:..",
     "react-router": "^7.9.5",
-    "react-syntax-highlighter": "^16.1.0"
+    "react-syntax-highlighter": "^16.1.0",
+    "showdown": "^2.1.0"
   },
   "devDependencies": {
     "@types/node": "^24.10.0",
     "@types/react": "^19.2.2",
     "@types/react-dom": "^19.2.2",
     "@types/react-syntax-highlighter": "^15.5.13",
+    "@types/showdown": "^2.0.6",
     "@vitejs/plugin-react": "^5.1.0",
     "react": "^19.2.0",
     "react-dom": "^19.2.0",

example/package.json

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+dirname=$(dirname "$(realpath "$0")")
+cd "$dirname/../../node_modules/react-activity-calendar/src/components" || exit 1
+json=$(pnpm dlx @react-docgen/cli ActivityCalendar.tsx)
+echo "$json" | jq '.["ActivityCalendar.tsx"][0]' > "$dirname/../src/docgen.json"