read changelog from `CHANGELOG.md` file (#2004)

* read changelog from `changelog.md` file

* Create bright-planes-bathe.md

* build fix

.changeset/bright-planes-bathe.md

@@ -0,0 +1,5 @@
+---
+"@tabler/core": patch
+---
+
+Automatically retrieve and display the changelog from the CHANGELOG.md file.

CHANGELOG.md

@@ -1,8 +1,5 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
-
-
 ## `1.0.0-beta20` - 2023-08-24
 
 - Update `bootstrap` to v5.3.1

src/pages/_data/changelog.yml

@@ -1,337 +0,0 @@
-- version: 1.0.0-beta
-  date: 2021-02-17
-  description: Initial beta release of Tabler v1.0! Lots more coming soon though 😁
-  changes:
-    - update Bootstrap to 5.0.0-beta2
-    - update other dependencies.
-
-- version: 1.0.0-beta2
-  date: 2021-03-29
-  changes:
-    - update dependencies
-    - "`li` marker fix"
-    - page wrapper, nav fixes
-    - scripts optimize, remove `capture_once`
-    - "`page-body` fixes"
-    - layout navbar fix
-    - typography fix
-    - ribbon fix
-    - charts label fixes
-    - charts docs
-
-- version: 1.0.0-beta3
-  date: 2021-05-08
-  changes:
-    - upgrade Bootstrap to 5.0
-    - upgrade dependencies
-    - change `$border-radius-pill` variable
-    - badge vertical align fix
-
-- version: 1.0.0-beta4
-  date: 2021-10-24
-  changes:
-    - upgrade required node.js version to 14
-    - upgrade Bootstrap to 5.1
-    - upgrade dependencies
-    - "fix #775 - litepicker not initializing"
-    - fix `nouislider` import in dev
-
-- version: 1.0.0-beta5
-  date: 2021-12-07
-  description: Tabler has finally lived to see dark mode! 🌝🌚
-  changes:
-    - "**Dark mode enabled!**"
-    - add more cursors (#947)
-    - "fix #892 - media queries need to be nested when negating"
-    - update `@tabler/icons` to newest version
-    - move optional dependencies to peerDependencies (#924)
-    - move deployment to Github Actions (#934)
-    - table border fixes
-    - antialiased fix
-    - update `@tabler/icons` to version 1.42
-    - change default font to 'Inter'
-    - colors unify
-    - add `tom-select` and remove `choices.js`
-
-- version: 1.0.0-beta6
-  date: 2022-01-18
-  changes:
-    - pricing cards fix
-    - "fix bug `fw-...`, `.fs-...` is missed (#987)"
-    - avatar class fix
-    - "fix bug #903 `litepicker` with date range not having correct border"
-    - page wrapper fix
-    - "fix #900 `is-invalid-lite` class is not working under `was-validated` form class"
-    - update `@tabler/icons` to version 1.48
-    - "fix #960 - Badges not honoring font sizes"
-    - "fix #959 - `node-sass` does not properly compile nested media queries"
-    - update package dependencies to newest version
-
-- version: 1.0.0-beta7
-  date: 2022-02-05
-  changes:
-    - "fix: #1019 - project-overview.html link not working"
-    - "fix: #1010 - card with bottom tabs has incorrect border radius"
-    - uptime monitor mobile fixes
-    - navbar dark button fix
-    - "`tabler-icons` link"
-    - autoloading webfonts
-    - "cards fixes, new cards demos"
-    - ruby dependencies update
-    - RTL stylesheet fixes
-    - new card action demos
-
-- version: 1.0.0-beta8
-  date: 2022-02-05
-  changes:
-    - update dependencies
-    - new vector maps demos
-    - fixes update map on resize
-    - docs improvement
-    - replace `badge` with `status-dot` in `navbar-notifications.html`
-    - map tooltip fixes
-
-- version: 1.0.0-beta9
-  date: 2022-02-26
-  changes:
-    - "fix: #1061 - list group item colors in light and dark modes"
-    - new `tasks` dashboard
-    - "fix: #1059 - upload button in form element in dark view has problem"
-    - "fix: #1052 - card background icon is practically invisible"
-    - remove Inter font and use default font system stack
-    - "fix: #1018 - vector map not working"
-    - "fix: #1035 - wrong background color of hovered list group items in dark mode"
-    - dependencies update
-    - "add `font-display: swap;` to improve font loading"
-    - new `Boxed` layout
-
-- version: 1.0.0-beta10
-  date: 2022-04-29
-  changes:
-    - "new `datatable` component"
-    - update Tabler Icons to v1.67
-    - "fix: #1024 - fix Tom-select in dark mode"
-    - "new carousel indicators: dots, vertical, thumbs (#1101)"
-    - "replace !important modifier with more specific selectors (#1100)"
-    - "new `FAQ` page"
-
-- version: 1.0.0-beta11
-  date: 2022-07-05
-  changes:
-    - "new `Dropzone` component"
-    - "new `Lightbox` component"
-    - "new `TinyMCS` component"
-    - "new `Inline Player` component"
-    - "new `Pricing table` component"
-    - "new `Datagrid` component"
-    - new optgroup form examples
-    - new settings page
-    - update Tabler Icons to v1.78
-    - added popover docs page
-    - "fix: #1125 incorrect chart display in the mobile version"
-    - update Bootstrap to 5.2.0
-
-- version: 1.0.0-beta12
-  date: 2022-09-19
-  changes:
-    - new "Job listing" page
-    - new "Sign in with cover" page
-    - new "Logs" page
-    - new `progressbg` component
-    - add a lot of CSS variables
-    - add Dockerfile with alpine base
-    - add icon pulse/tada/rotate animations
-    - "use `:host` in selectors to support Web Components"
-    - "use dark table variant colors in dark mode (#1200)"
-    - update Tabler Icons to v1.96
-    - "change `space-y` component"
-    - headings, shadows and borders unify
-    - toggle TinyMCE dark mode and skin based on the set Tabler theme
-    - fix `card-footer` background
-    - fix headers weight
-    - fix transparent hover background in pagination
-    - fix dark mode card text color
-    - "fix `--#{$prefix}card-bg` is undefined"
-    - "fix global variable for `.card` and `.btn`"
-    - fix code sample in the customize tabler docs
-    - fix form elements demo page radio buttons
-    - "replace `gulp-minify` with `gulp-terser`"
-
-- version: 1.0.0-beta13
-  date: 2022-10-18
-  changes:
-    - "update Bootstrap to 5.2.1, update dependencies"
-    - new `tracking` component
-    - new radio button version of `form-imagecheck`
-    - update icons to v1.105.0
-    - dark mode improvements
-    - corrects the spelling of New Zealand (#1318)
-    - remove `$border-color-dark`
-    - "fix #1301 - code snippets in docs look bad in dark mode"
-    - "fix #1305 - different default link color for dark mode"
-    - fix popover background in dark mode
-    - fix button default border color
-    - fix `form-imagecheck` bg in dark mode
-    - navbar logo fix
-    - move card ribbons config to variables
-    - navbar border fix
-    - dark mode active fix
-    - using globalThis instead of window (#1315)
-    - "fix #1210 - lastmod not generated for pages in `sitemap.xml`"
-    - fix card border in dark mode
-    - "fix #895 - background color overwrites background image"
-    - "fix #1302 - wrong card header in dark mode"
-    - "fix #1303 - wrong color when hovering over `selectgroup` in dark mode"
-    - "fix #1308 - bad coloring in table in dark mode"
-    - "fix #1273 - datepicker background color broken"
-    - "fix `$prefix` hard coded `layout/_dark.scss`"
-    - "fix #1275 - remove last border-right on progress bar"
-    - "fix #1261 - broken offcanvas bg"
-
-- version: 1.0.0-beta14
-  date: 2022-10-21
-  changes:
-    - fix active items in dark mode
-    - update Jekyll to newest version
-
-- version: 1.0.0-beta15
-  date: 2022-11-01
-  changes:
-    - new `badges` page
-    - "`<kbd>` styling"
-    - update icons to v1.109.0
-    - "`tom-select` border fix"
-    - exclude `playgrounds` from build
-    - update jekyll to v4.3.1
-    - "fix: facebook color update"
-    - navbar aria atributes fixes
-    - "fix #808 - `navbar-menu` and `sidebar-menu` has the same `id`"
-    - "fix #1335 - missing color variables usage in `alert` and `btn-ghost-*`"
-    - move border style to CSS variables
-    - add missing forms
-    - "`btn-actions` fixes"
-    - "replace `$text-muted` to css variable"
-
-- version: 1.0.0-beta16
-  date: 2022-11-12
-  changes:
-    - new `Photogrid` page
-    - "`Steps` component improvements"
-    - "fix #1348: Make job listing responsive for smaller devices"
-    - "fix #1357: buttons group not active"
-    - "fix #1352: fix deprecation warning"
-    - "fix #1180: number input with `form-control-sm` looks weird"
-    - "fix #1328: color input should show different color for inner check symbol on white ellipse"
-    - "fix #1355 - missing font sizes"
-    - update icons to v1.111.0
-    - homepage navbar fix
-    - "fix #1262 - `.bg-opacity-xx` class is not functioning properly"
-
-- version: 1.0.0-beta17
-  date: 2023-01-28
-  changes:
-    - update `bootstrap` to v5.3.0
-    - update icons to v2.1.2
-    - add 72 new brands, browsers logos update
-    - new `Trial ended` page
-    - new `Page loader` page
-    - new `Profile` page
-    - headings fix
-    - dropdown background color fix
-    - fix rgba conversion bug
-    - fix autofill text color, not matching in dark mode
-    - update license
-    - header html5 tags
-    - "add input with appended `<kbd>`"
-    - "`bootstrap` import fix"
-    - font improvements
-    - "change `$body-color` to CSS variable"
-    - scrollbars improvements
-    - "move `@tabler/icons` to `dev-dependencies`"
-    - "fix #1370: avatar stacked list is not stacked anymore"
-
-- version: 1.0.0-beta18
-  date: 2023-05-14
-  changes:
-    - "new page: Cookie banner"
-    - Unify dark mode with latest Bootstrap API and improve dark mode elements (#1561)
-    - Update Tabler Icons to version 2.18 with 18 new icons added (#1560)
-    - Switch from `npm` to `pnpm` for faster package installation (#1559)
-    - Add Prettier to project for consistent code formatting (#1558)
-    - Update required Node.js version to 18 and add `.nvmrc` file (#1555)
-    - Add All Contributions package to project for easy contribution tracking (#1556)
-    - Add support for changeset tool for more efficient and organized code changes (#1553)
-    - Fix bug where `border-1`, `border-2`, etc don't work (#1526)
-    - Fix indeterminate input background color (#1536)
-    - Update Bootstrap to `5.3.0-alpha3` (#1543)
-    - "`tom-select` dark mode styling fixes"
-    - Advanced udage of `tom-select` (#1480)
-    - Fix Dropdown menu in rtl mode (#801)
-    - Fix `tom-select` dropdown will be shaded in table-responsive (#1409)
-    - Remove overflow scroll from body
-    - Fix avatars overlap transparently (#1464)
-    - Fix TinyMCE dropdown icon list transparent (#1426)
-    - Dark mode lite colors improvement
-    - Fix non full width selects (#1392)
-
-- version: 1.0.0-beta19
-  date: 2023-05-15
-  changes:
-    - Add customizable Star Ratings component using `star-rating.js` library (#1571)
-    - Add new "Filled" section to Icons page (#1574)
-    - Fix form controls bugs in dark mode (#1573)
-    - Fix text color in dark version of navbar (#1569)
-    - Changelog update
-
-- version: 1.0.0-beta20
-  date: 2023-08-24
-  changes:
-    - Update `bootstrap` to v5.3.1
-    - Add new `Chat` component 
-    - Add new `Tag` component
-    - Add customizable Star Ratings component using `star-rating.js` library
-    - Add new color picker component using `coloris.js` library
-    - Add `alerts.html` page with example of alerts.
-    - Add `flags.html` page with list of all flags
-    - Add Two-Step Verification Pages
-    - Add variable to configure `avatar-list` spacing
-    - Unify dark mode with latest Bootstrap API and improve dark mode elements
-    - Unify Box Shadows with Bootstrap Compatibility
-    - Avoid SCSS color dependency on `:focus`
-    - Update CSS class from `text-muted` to `text-secondary` for better Bootstrap compatibility
-    - Fix text color in dark version of navbar
-    - Adjusting form element sizes for enhanced mobile devices compatibility
-    - Resolved light dropdown issue on dark theme
-    - Update Tabler Icons to version 2.32 with 48 new icons added
-    - Fix table default background color
-    - Fix responsiveness issue in Settings menu
-    - Update required Node.js version to 18 and add `.nvmrc` file
-    - Add support for changeset tool for more efficient and organized code changes
-    - "`Dockerfile` fix"
-    - Switch from `npm` to `pnpm` for faster package installation
-
-
-# - version: 1.0.0
-#   date: 2023-03-01
-#   description: Version 1.0 of Tabler! 😍🤩
-#   changes:
-#     - "new page: Cookie banner"
-#     - update icons to v2.7.0
-#     - "optimise images with `calibre/image-actions`"
-#     - new docs
-#     - spacers unify
-#     - "fix non full width selects #1392"
-#     - "fix bootstrap imports (#1477)"
-#     - update dependencies
-#     - images optimization
-#     - flags border fix
-#     - fix color variables
-#     - scss build fix
-#     - "fix #1440: more symmetry between modals and cards"
-#     - dropdown shadow fix, colors fix
-#     - "feat: dark mode lite colors improvement"
-#     - "fix #1464: avatars overlap transparently"
-#     - "fix #1426: TinyMCE drop down icon list transparent"
-#     - "fix #1453: Term of service page is truncated"
-#     - added epayco Latin America payment gateway
-#     - add canonical urls

src/pages/_plugins/jekyll-changelog.rb

@@ -0,0 +1,22 @@
+def get_changelog()
+  # return content of changelog.md file if exists
+  changelog_path = File.join(Dir.pwd, 'CHANGELOG.md')
+
+  if File.exist?(changelog_path)
+    File.read(changelog_path, encoding: 'utf-8')
+  else
+    ''
+  end
+
+  
+end
+
+module Jekyll
+  Jekyll::Hooks.register :pages, :pre_render do |page, jekyll|
+    jekyll.site['changelog'] = get_changelog()
+  end
+
+  Jekyll::Hooks.register :documents, :pre_render do |doc, jekyll|
+    jekyll.site['changelog'] = get_changelog()
+  end
+end

src/pages/changelog.html

@@ -4,25 +4,4 @@ menu: changelog
 layout: markdown
 ---
 
-<h1>Changelog</h1>
-
-{% for version in site.data.changelog reversed %}
-<div class="mb-4">
-	<h2 class="mb-2">
-		<span>{{ version.version }}</span> –
-		<small>{{ version.date | date: '%B %d, %Y' }}</small>
-	</h2>
-
-	{% if version.description %}
-	<p class="strong">{{ version.description }}</p>
-	{% endif %}
-
-	{% if version.changes %}
-	<ul>
-		{% for change in version.changes %}
-		<li>{{ change | markdownify | replace_regex: '</p>\s+$', '' | replace_regex: '^<p>', ''  | replace_regex: '#([0-9]+)', '<a href="https://github.com/tabler/tabler/issues/\1" target="_blank" rel="noopener">#\1</a>' }}</li>
-		{% endfor %}
-	</ul>
-	{% endif %}
-</div>
-{% endfor %}
+{{ site.changelog | markdownify }}