docs(Storybook): add Changelog page (#1174)

Endava · Jul 29, 2024 · f06be3f · f06be3f
1 parent a165fd0
commit f06be3f
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,6 +17,7 @@ packages/beeq/.storybook/assets/css/stories.css
 packages/beeq/vite.config.*.timestamp-*
 packages/beeq/custom-elements.json
 packages/beeq/src/components/icon/svg/**
+packages/beeq/src/_storybook/CHANGELOG.md
 packages/beeq-angular/**/directives
 packages/beeq-react/src/react-component-lib
 packages/beeq-react/src/components.ts

diff --git a/nx.json b/nx.json
@@ -42,8 +42,12 @@
     "lint": {
       "cache": true
     },
+    "prepare-storybook": {
+      "cache": true
+    },
     "storybook-build": {
       "dependsOn": [
+        { "target": "prepare-storybook", "projects": "beeq" },
         { "target": "build", "projects": "beeq" },
         { "target": "storybook-build-css", "projects": "beeq" }
       ],

diff --git a/packages/beeq/.storybook/assets/css/preview.css b/packages/beeq/.storybook/assets/css/preview.css
@@ -41,9 +41,24 @@
   font-size: var(--bq-font-size--xxl2);
 }
 
-.sbdocs-content h2 {
-  font-size: var(--bq-font-size--xxl);
+.sbdocs-content h2,
+.sbdocs-content h2 a {
   border-bottom: none;
+  font-size: var(--bq-font-size--xxl);
+}
+
+.sbdocs-content h2 a {
+  font-weight: var(--bq-font-weight--bold)
+}
+
+.sbdocs-content h2,
+.sbdocs-content h3 {
+  display: flex;
+  align-items: center;
+}
+
+.sbdocs-content h3 {
+  font-weight: var(--bq-font-weight--semibold);
 }
 
 .docblock-typeset {

diff --git a/packages/beeq/.storybook/preview.ts b/packages/beeq/.storybook/preview.ts
@@ -118,7 +118,7 @@ const preview: Preview = {
     },
     options: {
       storySort: {
-        order: ['Welcome', 'Foundation', 'Components'],
+        order: ['Welcome', "What's new", 'Foundation', 'Components'],
       },
     },
   },

diff --git a/packages/beeq/project.json b/packages/beeq/project.json
@@ -50,6 +50,7 @@
     },
     "storybook-start": {
       "executor": "@nx/storybook:storybook",
+      "dependsOn": [{ "target": "prepare-storybook" }],
       "options": {
         "loglevel": "silly",
         "configDir": "packages/beeq/.storybook",
@@ -170,6 +171,12 @@
         "configFile": "packages/beeq/.stylelintrc.json"
       }
     },
+    "prepare-storybook": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "cp CHANGELOG.md {projectRoot}/src/_storybook"
+      }
+    },
     "prepublish": {
       "executor": "nx:run-commands",
       "outputs": ["{options.outputPath}"],

diff --git a/packages/beeq/src/_storybook/changelog.mdx b/packages/beeq/src/_storybook/changelog.mdx
@@ -0,0 +1,10 @@
+import { Markdown, Meta } from '@storybook/blocks';
+import Changelog from './CHANGELOG.md?raw';
+
+<Meta title="What's new" />
+
+<div className="bq-doc__wrapper">
+  <div className="bq-doc__container" >
+    <Markdown>{Changelog}</Markdown>
+  </div>
+</div>