{"id":31396280,"url":"https://github.com/fardinhash/changelog-template","last_synced_at":"2026-05-16T11:32:57.704Z","repository":{"id":313947341,"uuid":"1053547692","full_name":"FardinHash/changelog-template","owner":"FardinHash","description":"Modern Changelog Template - Beautiful dark-themed MDX.js powered changelog template. Next.js + Tailwind CSS + TypeScript.","archived":false,"fork":false,"pushed_at":"2025-09-09T16:29:17.000Z","size":58,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-29T11:56:35.406Z","etag":null,"topics":["agentic-ai","changelog","changelog-activity","changelog-generator","changelog-template","changelogs","developer-tools","llm-examples","machine-learning-documentation","mdx-changelog","mdx-js","mdx-template","mdx-theme","nextjs-template","open-source","open-source-template","reinforcement-learning","release-notes","release-notes-generator","template"],"latest_commit_sha":null,"homepage":"","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FardinHash.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"FardinHash","patreon":"fardinkai","buy_me_a_coffee":"fardinkai"}},"created_at":"2025-09-09T15:43:33.000Z","updated_at":"2025-09-09T16:28:25.000Z","dependencies_parsed_at":"2025-09-09T19:08:14.723Z","dependency_job_id":"edc4e55a-dc67-4058-9600-eb168c7be9fb","html_url":"https://github.com/FardinHash/changelog-template","commit_stats":null,"previous_names":["fardinhash/changelog-template"],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/FardinHash/changelog-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FardinHash%2Fchangelog-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FardinHash%2Fchangelog-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FardinHash%2Fchangelog-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FardinHash%2Fchangelog-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FardinHash","download_url":"https://codeload.github.com/FardinHash/changelog-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FardinHash%2Fchangelog-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33100858,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T04:41:52.686Z","status":"ssl_error","status_checked_at":"2026-05-16T04:41:52.009Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agentic-ai","changelog","changelog-activity","changelog-generator","changelog-template","changelogs","developer-tools","llm-examples","machine-learning-documentation","mdx-changelog","mdx-js","mdx-template","mdx-theme","nextjs-template","open-source","open-source-template","reinforcement-learning","release-notes","release-notes-generator","template"],"created_at":"2025-09-29T11:56:29.134Z","updated_at":"2026-05-16T11:32:57.700Z","avatar_url":"https://github.com/FardinHash.png","language":"MDX","funding_links":["https://github.com/sponsors/FardinHash","https://patreon.com/fardinkai","https://buymeacoffee.com/fardinkai"],"categories":[],"sub_categories":[],"readme":"# Modern Changelog Template\n\nA beautiful, modern, and responsive changelog template built with **Next.js**, **MDX**, **Tailwind CSS**, and **React Icons**. Features a stunning dark theme with glass morphism effects and smooth animations.\n\n## Features\n\n- **Modern Dark Theme** - Beautiful dark UI with glass morphism effects\n- **MDX Support** - Write changelog entries in Markdown with React components\n- **Fully Responsive** - Perfect on desktop, tablet, and mobile devices\n- **TypeScript Ready** - Full TypeScript support for better development\n- **SEO Optimized** - Dynamic page titles and meta descriptions\n- **Static Export** - Deploy anywhere with static file hosting\n- **React Icons** - Beautiful icons from Feather and Remix Icon sets\n- **Tailwind CSS** - Utility-first CSS framework for rapid development\n- **Clean Code** - Well-structured, commented, and maintainable code\n\n## Quick Start\n\n### Prerequisites\n\n- Node.js 18.0 or higher\n- npm or yarn package manager\n\n### Installation\n\n1. **Clone or download this template**\n\n   ```bash\n   git clone https://github.com/FardinHash/changelog-template\n   cd changelog-template\n   ```\n\n2. **Install dependencies**\n\n   ```bash\n   npm install\n   # or\n   yarn install\n   ```\n\n3. **Start the development server**\n\n   ```bash\n   npm run dev\n   # or\n   yarn dev\n   ```\n\n4. **Open your browser**\n   Navigate to [http://localhost:3001](http://localhost:3001)\n\n## Customization\n\n### 1. Update Project Information\n\nEdit `pages/index.tsx` to customize:\n\n```typescript\n// Update these values\n\u003ch1\u003eYour Project Name\u003c/h1\u003e\n\u003cp\u003eYour Project Description - Release History\u003c/p\u003e\n\n// Update action buttons\n\u003ca href=\"https://your-docs-url.com\"\u003eDocumentation\u003c/a\u003e\n\u003ca href=\"https://github.com/your-username/your-repo\"\u003eGitHub\u003c/a\u003e\n```\n\n### 2. Update Layout Component\n\nEdit `components/Layout.tsx`:\n\n```typescript\n// Update page title format\n\u003ctitle\u003e{meta.version} - {meta.title} - Your Project Name\u003c/title\u003e\n\n// Update footer\n\u003cp\u003eYour Project Name\u003c/p\u003e\n\n// Update external link\n\u003ca href=\"https://your-docs-url.com\"\u003eDocumentation\u003c/a\u003e\n```\n\n### 3. Add Your Changelog Entries\n\nCreate new MDX files in the `pages/` directory:\n\n```bash\npages/\n  v3.0.mdx    # Your latest release\n  v2.9.mdx    # Previous release\n  v2.8.mdx    # And so on...\n```\n\n### 4. Update Release Data\n\nEdit the `releases` array in `pages/index.tsx`:\n\n```typescript\nconst releases = [\n  {\n    version: \"v3.0\",\n    title: \"Your Latest Release Title\",\n    date: \"January 15, 2025\",\n    status: \"Live\", // or \"Released\"\n    description: \"Brief description of what's new\",\n    contributors: [\"@yourusername\", \"@teammate\"],\n  },\n  // Add more releases...\n];\n```\n\n## Creating Changelog Entries\n\n### MDX File Structure\n\nEach changelog entry should be an MDX file with this structure:\n\n````mdx\nimport Layout from \"../components/Layout\";\n\nexport const meta = {\n  version: \"v2.1\",\n  title: \"Your Release Title\",\n  date: \"December 15, 2024\",\n  status: \"Live\", // or \"Released\"\n  contributors: [\"@contributor1\", \"@contributor2\"],\n};\n\n# Your Release Title\n\nYour changelog content goes here. You can use:\n\n## Headings\n\n### Subheadings\n\n- Bullet points\n- **Bold text**\n- _Italic text_\n- `Code snippets`\n\n```javascript\n// Code blocks\nconst example = \"Hello World\";\n```\n````\n\n## Tables\n\n| Feature | Before | After |\n| ------- | ------ | ----- |\n| Speed   | Slow   | Fast  |\n\n\u003e Blockquotes for important notes\n\nexport default ({ children }) =\u003e \u003cLayout meta={meta}\u003e{children}\u003c/Layout\u003e;\n\n````\n\n### Supported Markdown Features\n\n- Headers (H1-H6)\n- Bold and italic text\n- Code blocks with syntax highlighting\n- Tables\n- Lists (ordered and unordered)\n- Links\n- Blockquotes\n- Horizontal rules\n\n## Styling \u0026 Theming\n\n### Color Customization\n\nEdit `tailwind.config.js` to customize colors:\n\n```javascript\ntheme: {\n  extend: {\n    colors: {\n      primary: {\n        50: \"#f0f9ff\",   // Light accent\n        500: \"#3b82f6\",  // Main accent\n        600: \"#2563eb\",  // Darker accent\n        700: \"#1d4ed8\",  // Darkest accent\n      },\n    },\n  },\n},\n````\n\n### Custom Styles\n\nAdd custom styles in `styles/globals.css`. The template uses Tailwind's `@layer` directive for organization:\n\n```css\n@layer components {\n  .your-custom-class {\n    @apply bg-white/10 rounded-xl p-4;\n  }\n}\n```\n\n## Deployment\n\n### Static Export (Recommended)\n\n1. **Build for production**\n\n   ```bash\n   npm run build\n   # or\n   yarn build\n   ```\n\n2. **Deploy the `dist/` folder** to any static hosting service:\n   - Netlify\n   - Vercel\n   - DO\n   - GitHub Pages\n   - AWS S3\n   - Any CDN or web server\n\n### Custom Base Path\n\nIf deploying to a subdirectory, update `next.config.js`:\n\n```javascript\nconst nextConfig = {\n  basePath: \"/changelog\",\n  assetPrefix: \"/changelog/\",\n  // ... other config\n};\n```\n\n### Integration with Existing Projects\n\nTo integrate with an existing application:\n\n1. **Build the changelog**\n\n   ```bash\n   npm run build\n   ```\n\n2. **Serve the `dist/` folder** from your main application\n   - Copy `dist/` contents to your server's static directory\n   - Configure your server to serve these files at `/changelog/`\n   - Update routing to handle changelog URLs\n\n## Development\n\n### Available Scripts\n\n- `npm run dev` - Start development server\n- `npm run build` - Build for production\n- `npm run start` - Start production server\n- `npm run export` - Build and export static files\n\n### Adding New Features\n\nThe template is designed to be easily extensible:\n\n1. **Add new React components** in the `components/` directory\n2. **Create new pages** in the `pages/` directory\n3. **Add custom styles** in `styles/globals.css`\n4. **Install additional dependencies** as needed\n\n## Troubleshooting\n\n### Common Issues\n\n1. **Port already in use**\n\n   ```bash\n   # Use a different port\n   npm run dev -- -p 3002\n   ```\n\n2. **Build errors**\n\n   ```bash\n   # Clear Next.js cache\n   rm -rf .next\n   npm run build\n   ```\n\n### Getting Help\n\n- Check the [Next.js documentation](https://nextjs.org/docs)\n- Review [MDX documentation](https://mdxjs.com/)\n- Browse [Tailwind CSS documentation](https://tailwindcss.com/docs)\n\n## License\n\nThis template is released under the MIT License. Feel free to use it in your projects, both personal and commercial.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit issues and pull requests.\n\n---\n\n**Happy changelog writing!**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffardinhash%2Fchangelog-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffardinhash%2Fchangelog-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffardinhash%2Fchangelog-template/lists"}