Merge pull request #79 from atomicjolt/sc/docs-fixes

docs: fixed doc building & maybe fix building docs on tag push
atomicjolt · Jan 21, 2025 · 2412968 · 2412968
2 parents e465e36 + 993bafe
commit 2412968
Show file tree

Hide file tree

Showing 7 changed files with 2,479 additions and 741 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,8 +1,9 @@
-name: Deploy Storybook to GitHub Pages
+name: Deploy Docs to GitHub Pages
 
 on:
   push:
-    tags: ["*"]
+    tags:
+      - "@*"
 
 jobs:
   build:

diff --git a/bin/update-css-props.ts → bin/update-css-props.mts b/bin/update-css-props.ts → bin/update-css-props.mts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,6 @@
 {
   "name": "atomic-packages",
   "private": true,
-  "type": "module",
   "workspaces": [
     "packages/atomic-elements",
     "packages/atomic-fuel",
@@ -16,7 +15,7 @@
     "prepare": "npm run storybook:cssprops",
     "playground": "vite --config playground/vite.config.ts dev",
     "storybook:dev": "storybook dev -p 6006 ",
-    "storybook:cssprops": "tsx bin/update-css-props.ts",
+    "storybook:cssprops": "tsx bin/update-css-props.mts",
     "storybook:build": "npm run storybook:cssprops && storybook build -o docs/build/storybook",
     "storybook:publish": "npm run storybook:build ${0} && gh-pages -d docs -m ${0}",
     "storybook:publish:next": "npm run storybook:build next && gh-pages -d docs/next -m next -e next",
@@ -31,10 +30,10 @@
   },
   "dependencies": {
     "@changesets/cli": "^2.27.10",
-    "@docusaurus/core": "^3.6.1",
-    "@docusaurus/plugin-content-docs": "^3.6.1",
-    "@docusaurus/preset-classic": "^3.6.1",
-    "@docusaurus/theme-classic": "^3.6.1",
+    "@docusaurus/core": "^3.7.0",
+    "@docusaurus/plugin-content-docs": "^3.7.0",
+    "@docusaurus/preset-classic": "^3.7.0",
+    "@docusaurus/theme-classic": "^3.7.0",
     "@ljcl/storybook-addon-cssprops": "^4.0.0",
     "@storybook/addon-actions": "^8.0.10",
     "@storybook/addon-docs": "^8.0.10",

diff --git a/packages/atomic-elements/docs/Storybook.mdx b/packages/atomic-elements/docs/Storybook.mdx
@@ -14,7 +14,7 @@ a complex dev stack, force certain data into your database, or navigate around y
 
 Storybook is organized into components. Each component is made up of documentation and one or more stories.
 
-![Storybook Hiearchy](https://storybook.js.org/056e66376330392b5bcc10deb45814b2/naming-hierarchy-sidebar-anatomy.png)
+<img src="/atomic-libs/img/storybook-hiearchy.png" alt="Storybook Hiearchy" />
 
 ## Controls
 
@@ -24,8 +24,8 @@ Controls are ways that you can interact with your component.
   src="/atomic-libs/video/addon-controls-demo-optimized.mp4"
   height="600"
   width="100%"
-  loop="true"
-  autoplay="true"
+  loop
+  autoPlay
 />
 
 Reference the [Storybook docs on how to develop controls](https://storybook.js.org/docs/react/essentials/controls)
@@ -38,8 +38,8 @@ Actions are used to observe data emitted by event handlers in components.
   src="/atomic-libs/video/addon-actions-demo-optimized.mp4"
   height="600"
   width="100%"
-  loop="true"
-  autoplay="true"
+  loop
+  autoPlay
 />
 
 [Storybook docs on Actions](https://storybook.js.org/docs/react/essentials/actions)

diff --git a/public/img/storybook-controls.png b/public/img/storybook-controls.png
diff --git a/public/img/storybook-hiearchy.png b/public/img/storybook-hiearchy.png