Chore/upgrade

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/docs-deploy.yml

@@ -0,0 +1,24 @@
+name: docs deploy
+on:
+  workflow_dispatch:
+
+permissions:
+  pages: write
+  id-token: write
+
+jobs:
+  call-npm-package-docs-detect:
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-docs-detect.yml@v1.0.2
+
+  call-npm-package-docs-checks:
+    needs: call-npm-package-docs-detect
+    if: ${{ needs.call-npm-package-docs-detect.outputs.detected == 'true' }}
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-docs-checks.yml@v1.0.2
+    secrets:
+      GH_DEPLOY_TOKEN: ${{ secrets.GH_DEPLOY_TOKEN }}
+
+  call-npm-package-docs-publish:
+    needs: call-npm-package-docs-checks
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-docs-publish.yml@v1.0.2
+    secrets:
+      GH_DEPLOY_TOKEN: ${{ secrets.GH_DEPLOY_TOKEN }}

.github/workflows/main-bump.yml

@@ -0,0 +1,17 @@
+name: main bump
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  call-ci-bump:
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/ci-bump.yml@v1.0.2
+    secrets:
+      GH_DEPLOY_TOKEN: ${{ secrets.GH_DEPLOY_TOKEN }}
+    with:
+      config_file: ".release-please/main-config.json"
+      manifest_file: ".release-please/main-manifest.json"
+      target_branch: "main"

.github/workflows/main-deploy.yml

@@ -1,23 +1,17 @@
-name: Main Deploy
+name: main bump
 on:
-  push:
-    branches:
-      - "main"
   workflow_dispatch:
+
 permissions:
-  id-token: write
   contents: write
   pull-requests: write
 
 jobs:
-  call-npm-package-deploy:
-    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-deploy.yml@main
+  call-ci-bump:
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/ci-bump.yml@v1.0.2
     secrets:
       GH_DEPLOY_TOKEN: ${{ secrets.GH_DEPLOY_TOKEN }}
-      NPM_ORG_OGS_GMBH_CI: ${{ secrets.NPM_ORG_OGS_GMBH_CI }}
-      FONTAWESOME_REGISTRY_AUTH_TOKEN: ${{ secrets.FONTAWESOME_REGISTRY_AUTH_TOKEN }}
-      MS_TEAMS_URL: ${{ secrets.MS_TEAMS_URL }}
     with:
-      release_please_config_file: ".release-please/main-config.json"
-      release_please_manifest_file: ".release-please/main-manifest.json"
-      release_please_target_branch: "main"
+      config_file: ".release-please/main-config.json"
+      manifest_file: ".release-please/main-manifest.json"
+      target_branch: "main"

.github/workflows/next-bump.yml

@@ -0,0 +1,17 @@
+name: next bump
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  call-ci-bump:
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/ci-bump.yml@v1.0.2
+    secrets:
+      GH_DEPLOY_TOKEN: ${{ secrets.GH_DEPLOY_TOKEN }}
+    with:
+      config_file: ".release-please/next-config.json"
+      manifest_file: ".release-please/next-manifest.json"
+      target_branch: "next"

.github/workflows/next-deploy.yml

@@ -1,21 +1,22 @@
-name: Next Deploy
+name: next deploy
 on:
   push:
     branches:
       - "next"
   workflow_dispatch:
+
 permissions:
   id-token: write
   contents: write
   pull-requests: write
+  pages: write
 
 jobs:
   call-npm-package-deploy:
-    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-deploy.yml@main
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-deploy.yml@v1.0.2
     secrets:
       GH_DEPLOY_TOKEN: ${{ secrets.GH_DEPLOY_TOKEN }}
       NPM_ORG_OGS_GMBH_CI: ${{ secrets.NPM_ORG_OGS_GMBH_CI }}
-      FONTAWESOME_REGISTRY_AUTH_TOKEN: ${{ secrets.FONTAWESOME_REGISTRY_AUTH_TOKEN }}
       MS_TEAMS_URL: ${{ secrets.MS_TEAMS_URL }}
     with:
       release_please_config_file: ".release-please/next-config.json"

.github/workflows/npm-deploy.yml

@@ -0,0 +1,13 @@
+name: npm deploy
+on:
+  workflow_dispatch:
+
+jobs:
+  call-npm-package-checks:
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-checks.yml@v1.0.2
+
+  call-npm-package-publish:
+    needs: call-npm-package-checks
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-publish.yml@v1.0.2
+    secrets:
+      NPM_ORG_OGS_GMBH_CI: ${{ secrets.NPM_ORG_OGS_GMBH_CI }}

.github/workflows/pr-review.yml

@@ -10,6 +10,4 @@ on:
 
 jobs:
   call-npm-package-pr-checks:
-    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-pr-checks.yml@main
-    secrets:
-      FONTAWESOME_REGISTRY_AUTH_TOKEN: ${{ secrets.FONTAWESOME_REGISTRY_AUTH_TOKEN }}
+    uses: OGS-GmbH/reusable-github-actions/.github/workflows/npm-package-pr-checks.yml@v1.0.2

.gitignore

@@ -1,3 +1,5 @@
 dist
 node_modules
 .idea
+.vscode
+.vitepress/.vitepress/cache/

.vitepress/.vitepress/config.mts

@@ -0,0 +1,106 @@
+import { defineConfig } from 'vitepress'
+import { groupIconMdPlugin, groupIconVitePlugin } from "vitepress-plugin-group-icons"
+import packageJson from "../../package.json";
+import {sidebarPlugin} from "@ogs-gmbh/vitepress-plugin-sidebar"
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  ignoreDeadLinks: true,
+  title: "ngx-m3-themes",
+  description: "A theming system with full Material Design 3 support that enables custom color palettes, design tokens, and motion-compliant components.",
+  themeConfig: {
+    externalLinkIcon: true,
+    search: {
+      provider: "local"
+    },
+    // https://vitepress.dev/reference/default-theme-config
+    logo: {
+      light: "https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/dark.svg",
+      dark: "https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/light.svg",
+      alt: "OGS GmbH Logo"
+    },
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: 'Copyright © 2025 — present <a target="_blank" href="https://www.ogs.de/en/">OGS GmbH</a>'
+    },
+    nav: [
+      { text: "Guide", link: "/guide" },
+      { text: "Reference", link: "/reference" },
+      { text: packageJson.version, items: [
+        { text: "Repository", link: "https://github.com/OGS-GmbH/ngx-m3-themes" },
+        { text: "Changelog", link: "https://github.com/OGS-GmbH/ngx-m3-themes/blob/main/CHANGELOG.md" },
+      ] }
+    ],
+    socialLinks: [
+      { icon: "github", link: "https://github.com/OGS-GmbH" },
+      { icon: "facebook", link: "https://www.facebook.com/OGS.GmbH" },
+      { icon: { svg: '<svg fill="currentColor" xmlns="http://www.w3.org/2000/svg" xml:space="preserve" viewBox="0 0 382 382"><path d="M347.445 0H34.555C15.471 0 0 15.471 0 34.555v312.889C0 366.529 15.471 382 34.555 382h312.889C366.529 382 382 366.529 382 347.444V34.555C382 15.471 366.529 0 347.445 0zM118.207 329.844c0 5.554-4.502 10.056-10.056 10.056H65.345c-5.554 0-10.056-4.502-10.056-10.056V150.403c0-5.554 4.502-10.056 10.056-10.056h42.806c5.554 0 10.056 4.502 10.056 10.056v179.441zM86.748 123.432c-22.459 0-40.666-18.207-40.666-40.666S64.289 42.1 86.748 42.1s40.666 18.207 40.666 40.666-18.206 40.666-40.666 40.666zM341.91 330.654a9.247 9.247 0 0 1-9.246 9.246H286.73a9.247 9.247 0 0 1-9.246-9.246v-84.168c0-12.556 3.683-55.021-32.813-55.021-28.309 0-34.051 29.066-35.204 42.11v97.079a9.246 9.246 0 0 1-9.246 9.246h-44.426a9.247 9.247 0 0 1-9.246-9.246V149.593a9.247 9.247 0 0 1 9.246-9.246h44.426a9.247 9.247 0 0 1 9.246 9.246v15.655c10.497-15.753 26.097-27.912 59.312-27.912 73.552 0 73.131 68.716 73.131 106.472v86.846z"/></svg>' }, link: "https://www.linkedin.com/company/41198063/" },
+      { icon: "xing", link: "https://www.xing.com/pages/ogsgmbh" },
+      { icon: { svg: '<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24"><circle cx="12" cy="12" r="10"/><path d="M12 2a14.5 14.5 0 0 0 0 20 14.5 14.5 0 0 0 0-20M2 12h20"/></svg>' }, link: "https://www.ogs.de/en/" },
+      { icon: { svg: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M140-160q-24 0-42-18t-18-42v-520q0-24 18-42t42-18h680q24 0 42 18t18 42v520q0 24-18 42t-42 18H140Zm340-302L140-685v465h680v-465L480-462Zm0-60 336-218H145l335 218ZM140-685v-55 520-465Z"/></svg>' }, link: "mailto:info@ogs.de" }
+    ],
+    sidebar: [
+      {
+        text: "Guide",
+        items: [
+          { text: "Getting started", link: "/guide/" },
+          { text: "Custom Color Palettes", link: "/guide/custom-color-palettes" }
+        ]
+      },
+      sidebarPlugin({
+        path: "./dist/vitepress-src/reference",
+        normalizeDirNames: false,
+        normalizeDirNamesFn (dirName: string): string {
+          const words: string[] = dirName.split("-");
+
+          for (let i: number = 0; i < words.length; i++) {
+            const currentWord: string = words[i];
+
+            words[i] = currentWord.charAt(0).toUpperCase() + currentWord.slice(1);
+          }
+
+          return words.join(" ");
+        }
+      }),
+      {
+        text: "Other",
+        items: [
+          { text: "Contributing", link: "/other/contributing" },
+          { text: "Code of Conduct", link: "/other/code-of-conduct" }
+        ]
+      },
+      {
+        text: "Legal",
+        items: [
+          { text: "Disclaimer", link: "/legal/disclaimer" },
+          { text: "MIT License", link: "/legal/license" },
+          { text: "Copyright © 2025 — present OGS GmbH", link: "https://www.ogs.de/en/" }
+        ]
+      }
+    ]
+  },
+  head: [
+    [ "link", { rel: "shortcut icon", href: "https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.1.0/docs/assets/favicon/favicon.ico" } ],
+    [ "link", { rel: "apple-touch-icon", href: "https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.1.0/docs/assets/favicon/apple-touch-icon.png" } ],
+    [ "link", { rel: "manifest", href: "site.webmanifest" } ],
+    [ "link", { rel: "icon", type: "image/svg+xml", href: "https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.1.0/docs/assets/favicon/favicon.svg" } ],
+    [ "link", { rel: "icon", type: "image/png", href: "https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.1.0/docs/assets/favicon/favicon-96x96.png", sizes: "96x96" } ]
+  ],
+  base: "/ngx-m3-themes/",
+  srcDir: "../dist/vitepress-src",
+  outDir: "../dist/docs",
+  titleTemplate: ":title - OGS ngx-m3-themes",
+  cleanUrls: true,
+  appearance: true,
+  markdown: {
+    /* eslint-disable-next-line @tseslint/typedef */
+    config(md) {
+      md.use(groupIconMdPlugin)
+    }
+  },
+  vite: {
+    plugins: [
+      groupIconVitePlugin()
+    ]
+  }
+});

.vitepress/.vitepress/theme/custom.scss

@@ -0,0 +1,3 @@
+@use "@ogs-gmbh/vitepress-theme" as vitepress-theme;
+
+@include vitepress-theme.include();

.vitepress/.vitepress/theme/index.ts

@@ -0,0 +1,6 @@
+import "virtual:group-icons.css";
+import "./custom.scss";
+import DefaultTheme from "vitepress/theme";
+
+/* eslint-disable-next-line @unicorn/prefer-export-from */
+export default DefaultTheme;