spoko-design-system 0.0.1 → 0.0.2

package/.github/workflows/deploy.yml

@@ -1,40 +1,40 @@
-name: Deploy to GitHub Pages
-
-on:
-  # Trigger the workflow every time you push to the `main` branch
-  # Using a different branch name? Replace `main` with your branch’s name
-  push:
-    branches: [ ma ]
-  # Allows you to run this workflow manually from the Actions tab on GitHub.
-  workflow_dispatch:
-
-# Allow this job to clone the repo and create a page deployment
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout your repository using git
-        uses: actions/checkout@v3
-      - name: Install, build, and upload your site
-        uses: withastro/action@v1
-        with:
-            pnpm@latest
-          # path: . # The root location of your Astro project inside the repository. (optional)
-          # node-version: 18 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
-          # package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
-
-  deploy:
-    needs: build
-    runs-on: ubuntu-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
+name: Deploy to GitHub Pages
+
+on:
+  # Trigger the workflow every time you push to the `main` branch
+  # Using a different branch name? Replace `main` with your branch’s name
+  push:
+    branches: [ ma ]
+  # Allows you to run this workflow manually from the Actions tab on GitHub.
+  workflow_dispatch:
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v3
+      - name: Install, build, and upload your site
+        uses: withastro/action@v1
+        with:
+            pnpm@latest
+          # path: . # The root location of your Astro project inside the repository. (optional)
+          # node-version: 18 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
+          # package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
         uses: actions/deploy-pages@v1

package/.stackblitzrc

@@ -1,6 +1,6 @@
-{
-  "startCommand": "npm start",
-  "env": {
-    "ENABLE_CJS_IMPORTS": true
-  }
+{
+  "startCommand": "npm start",
+  "env": {
+    "ENABLE_CJS_IMPORTS": true
+  }
 }

package/.vscode/extensions.json

@@ -1,4 +1,4 @@
-{
-  "recommendations": ["astro-build.astro-vscode"],
-  "unwantedRecommendations": []
-}
+{
+  "recommendations": ["astro-build.astro-vscode"],
+  "unwantedRecommendations": []
+}

package/.vscode/launch.json

@@ -1,11 +1,11 @@
-{
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "command": "./node_modules/.bin/astro dev",
-      "name": "Development server",
-      "request": "launch",
-      "type": "node-terminal"
-    }
-  ]
-}
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "./node_modules/.bin/astro dev",
+      "name": "Development server",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Jordi Enric Roig Ramis
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Jordi Enric Roig Ramis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Layout/Header.astro

@@ -1,89 +1,111 @@
----
-import { Icon } from 'astro-icon/components';
-import Search from "astro-pagefind/components/Search";
-// import Search from "components/NavbarSearch.astro";
-import { t } from "i18next";
-const { translation, locale } = Astro.props;
-
-import { Image } from 'astro:assets';
-import vwLogo from './../../../public/vw.svg'
-
-const likes = {
-    list: {
-        ids: [0, 1, 2]
-    }
-}
----
-<style lang="scss">
-.logo {
-    max-height: 25px;
-    max-width: 25px;
-}
-</style>
-
-
-  <nav class="nav print-hidden" itemscope itemtype="http://schema.org/WPHeader">
-    <div class="mx-auto px-4 shadow-md ">
-    <div class="relative flex items-center justify-between h-24 sm:h-14 flex-wrap pt-1 sm:pt-0">
-        <div class="flex items-center justify-start sm:items-stretch order-1">
-          <div class="flex-shrink-0 flex items-center h-8"  >
-            <a class="flex items-center" href={locale !== 'en' ? `/${locale}/` : '/'} title={t('catalog.title')}>
-              <Image src={vwLogo} alt="VW" width="25" height="25" class="logo mr-2 dark:text-white hover:animate-spin"/>
-              <span class="text-xl brand text-left leading-none dark:text-white">catalog
-                <span class="text-xs block leading-none -mt-0.5 text-lightBlue-500"><strong class="text-black font-400">polo</strong>blue</span>
-              </span>
-            </a>
-          </div>
-          <div class="hidden sm:block sm:ml-6">
-            <div class="flex space-x-4"  itemprop="hasPart">
-              <!-- <a href="https://uk-polos.net/viewforum.php?f=56" title="UK-Polos.net / Polo 6R/6C" target="_blank" rel="noopener" class="text-gray-400 hover:bg-blue-700 hover:text-white px-3 py-1 rounded-full text-sm font-medium">Forum</a> -->
-              <a href={`https://polo.blue${locale==='pl'?'/pl':''}`}
-              class="text-gray-400 hover:bg-blue-700 hover:text-white px-3 py-1 rounded-full text-sm font-medium"
-              title="Polo 6R Blog" itemprop="url">Blog</a>
-              <!-- <a href="#" class="text-gray-400 hover:bg-blue-700 hover:text-white px-3 py-1 rounded-full text-sm font-medium">Price Checker</a> -->
-            </div>
-          </div>
-        </div>
-
-        <div class="relative md:block sm:ml-4 w-full sm:w-64 sm:mr-auto order-4 sm:order-2 h-10">
-          <Search 
-            id="search"
-            transition:name="search-field"
-            transition:persist
-            className="search-container" 
-            uiOptions={{ 
-              showImages: true,
-              showEmptyFilters: false,
-              resetStyles: true,
-              translations: {  
-                clear_search: t('search.clear'),
-                placeholder: t('search.type-to-search'),
-                search_label: t('search.search_label'),
-                filters_label: t('search.filters'),
-                zero_results: t('search.zero-results'),
-                many_results: `[COUNT] ${t('search.results-for')} [SEARCH_TERM]`,
-                one_result: `[COUNT] ${t('search.result-for')} [SEARCH_TERM]`,
-                alt_search: t('search.alt_search'),
-                search_suggestion: t('search.search_suggestion'),
-                searching: t('search.searching'),
-                load_more: t('search.load-more')
-              }
-            }} 
-          />
-        </div>
-
-        <div class="flex items-center pr-0 sm:static sm:inset-auto ml-auto sm:ml-6 -mr-2  dark:text-gray-400 print:hidden order-3 sm:order-3 w-20 justify-end"
-          itemprop="hasPart" itemscope itemtype="http://schema.org/SiteNavigationElement"
-        >
-          <a class="icon-btn mx-2" 
-            title={t('button.toggle_langs')}
-            href={translation}
-            itemprop="url"
-            data-astro-reload
-          >
-              <Icon name="carbon:language" width="1.2em" height="1.2em"/>
-          </a>
-        </div>
-      </div>
-    </div>
-  </nav>
+---
+import { Icon } from "astro-icon/components";
+import Search from "astro-pagefind/components/Search";
+import { t } from "i18next";
+const { translation, locale } = Astro.props;
+
+import { Image } from "astro:assets";
+import vwLogo from "./../../../public/vw.svg";
+
+const likes = {
+  list: {
+    ids: [0, 1, 2],
+  },
+};
+---
+
+<nav class="nav print-hidden" itemscope itemtype="http://schema.org/WPHeader">
+  <div class="mx-auto px-4 shadow-md">
+    <div
+      class="relative flex items-center justify-between h-24 sm:h-14 flex-wrap pt-1 sm:pt-0"
+    >
+      <div class="flex items-center justify-start sm:items-stretch order-1">
+        <div class="flex-shrink-0 flex items-center h-8">
+          <a
+            class="flex items-center"
+            href={locale !== "en" ? `/${locale}/` : "/"}
+            title={t("catalog.title")}
+          >
+            <Image
+              src={vwLogo}
+              alt="VW"
+              width="25"
+              height="25"
+              class="logo mr-2 dark:text-white hover:animate-spin"
+            />
+            <span class="text-xl brand text-left leading-none dark:text-white"
+              >catalog
+              <span
+                class="text-xs block leading-none -mt-0.5 text-lightBlue-500"
+                ><strong class="text-black font-400">polo</strong>blue</span
+              >
+            </span>
+          </a>
+        </div>
+        <div class="hidden sm:block sm:ml-6">
+          <div class="flex space-x-4" itemprop="hasPart">
+            <a
+              href={`https://polo.blue${locale === "pl" ? "/pl" : ""}`}
+              class="text-gray-400 hover:bg-blue-700 hover:text-white px-3 py-1 rounded-full text-sm font-medium"
+              title="Polo 6R Blog"
+              itemprop="url">Blog</a
+            >
+          </div>
+        </div>
+      </div>
+
+      <div
+        class="relative md:block sm:ml-4 w-full sm:w-64 sm:mr-auto order-4 sm:order-2 h-10"
+      >
+        <Search
+          id="search"
+          transition:name="search-field"
+          transition:persist
+          className="search-container"
+          uiOptions={{
+            showImages: true,
+            showEmptyFilters: false,
+            resetStyles: true,
+            translations: {
+              clear_search: t("search.clear"),
+              placeholder: t("search.type-to-search"),
+              search_label: t("search.search_label"),
+              filters_label: t("search.filters"),
+              zero_results: t("search.zero-results"),
+              many_results: `[COUNT] ${t("search.results-for")} [SEARCH_TERM]`,
+              one_result: `[COUNT] ${t("search.result-for")} [SEARCH_TERM]`,
+              alt_search: t("search.alt_search"),
+              search_suggestion: t("search.search_suggestion"),
+              searching: t("search.searching"),
+              load_more: t("search.load-more"),
+            },
+          }}
+        />
+      </div>
+
+      <div
+        class="flex items-center pr-0 sm:static sm:inset-auto ml-auto sm:ml-6 -mr-2 dark:text-gray-400 print:hidden order-3 sm:order-3 w-20 justify-end"
+        itemprop="hasPart"
+        itemscope
+        itemtype="http://schema.org/SiteNavigationElement"
+      >
+        <a
+          class="icon-btn mx-2"
+          title={t("button.toggle_langs")}
+          href={translation}
+          itemprop="url"
+          data-astro-reload
+        >
+          <Icon name="carbon:language" />
+        </a>
+      </div>
+    </div>
+  </div>
+</nav>
+
+<style lang="scss">
+  .logo {
+    max-height: 25px;
+    max-width: 25px;
+  }
+</style>

package/README.md

@@ -1,69 +1,69 @@
----
-title: Introduction
-description: Docs intro
-layout: ../../layouts/MainLayout.astro
----
-
-# Spoko Design System
-
-Astro Design System is the easiest way to start your our design system. Since Astro is compatible with many frameworks, you can import your components and document them right in the markdown files.
-
-## Getting started
-
-### Adding new sections
-
-Although it's not required, you can create folders for new sections.
-
-To show the section on the left side navigation, add it to the navigation config file at `src/config.ts`.
-
-Example:
-https://spoko-design-system.netlify.app/
-
-```js
-export const SIDEBAR = [
-    { text: "Core", header: true },
-    { text: "Introduction", link: "/core/introduction" },
-    ...,
-    { text: "Components", header: true },
-    { text: "Buttons", link: "/components/buttons" },
-    ...,
-    { text: "New section", header: true },
-    { text: "New component", link: "/new-section/new-component.md" },
-];
-```
-
-### Adding new pages
-
-To add new pages just create an .astro or markdown file in `src/pages/[section]/my-page.md`. Remember to add it to the navigation config in `src/config.ts` so it shows up in the left side navigation.
-
-You're free to organize the pages however you want.
-
-### Customizing Core section (colors, typography, shadows...)
-
-If you want to customize the default colors, typography or shadows you can find the configuration file at `src/config/design.config.ts`.
-
-Feel free to add new pages to the Core section
-
-### Customizing the page layout
-
-You can find the css for the pages in `src/styles/content.scss`.
-
-### Adding your components
-
-Astro is great for design systems because it allows you to import components from different frameworks like react, vue or svelte.
-
-To get started check how the `MainButton` component is used in the `src/pages/en/buttons.md` file.
-
-You can import your component library or create your own and document it easily.
-
-### `.component-preview` utility
-
-There's a class called `.component-preview` that you can use to wrap your component in a grid, and it will look like this:
-
-<div class="component-preview">
-    <button class="text-white bg-blue-500 px-4 py-2 rounded-md">Your component</button>
-</div>
-
-### Have fun!
-
-Spoko Design System template was made by **[@spoko.space](https://spoko.space)** for personal and commercial use.
+---
+title: Introduction
+description: Docs intro
+layout: ../../layouts/MainLayout.astro
+---
+
+# Spoko Design System
+
+Astro Design System is the easiest way to start your our design system. Since Astro is compatible with many frameworks, you can import your components and document them right in the markdown files.
+
+## Getting started
+
+### Adding new sections
+
+Although it's not required, you can create folders for new sections.
+
+To show the section on the left side navigation, add it to the navigation config file at `src/config.ts`.
+
+Example:
+https://spoko-design-system.netlify.app/
+
+```js
+export const SIDEBAR = [
+    { text: "Core", header: true },
+    { text: "Introduction", link: "/core/introduction" },
+    ...,
+    { text: "Components", header: true },
+    { text: "Buttons", link: "/components/jumbatron" },
+    ...,
+    { text: "New section", header: true },
+    { text: "New component", link: "/new-section/new-component.md" },
+];
+```
+
+### Adding new pages
+
+To add new pages just create an .astro or markdown file in `src/pages/[section]/my-page.md`. Remember to add it to the navigation config in `src/config.ts` so it shows up in the left side navigation.
+
+You're free to organize the pages however you want.
+
+### Customizing Core section (colors, typography, shadows...)
+
+If you want to customize the default colors, typography or shadows you can find the configuration file at `src/config/design.config.ts`.
+
+Feel free to add new pages to the Core section
+
+### Customizing the page layout
+
+You can find the css for the pages in `src/styles/content.scss`.
+
+### Adding your components
+
+Astro is great for design systems because it allows you to import components from different frameworks like react, vue or svelte.
+
+To get started check how the `MainButton` component is used in the `src/pages/en/buttons.md` file.
+
+You can import your component library or create your own and document it easily.
+
+### `.component-preview` utility
+
+There's a class called `.component-preview` that you can use to wrap your component in a grid, and it will look like this:
+
+<div class="component-preview">
+    <button class="text-white bg-blue-500 px-4 py-2 rounded-md">Your component</button>
+</div>
+
+### Have fun!
+
+Spoko Design System template was made by **[@spoko.space](https://spoko.space)** for personal and commercial use.

package/astro-i18next.config.mjs

@@ -1,18 +1,18 @@
-/** @type {import('astro-i18next').AstroI18nextConfig} */
-export default {
-    defaultLocale: "en",
-    locales: ["en", "pl"],
-    i18next: {
-        // debug is convenient during development to check for missing keys
-        debug: true,
-        initImmediate: false,
-        // backend: {
-        //   loadPath: './src/locales/{{lng}}.yml',
-        // },
-        detection: {}, // Default detection settings
-      },
-      i18nextPlugins: {
-        fsBackend: 'i18next-fs-backend',
-        LanguageDetector: 'i18next-browser-languagedetector',
-      },
+/** @type {import('astro-i18next').AstroI18nextConfig} */
+export default {
+    defaultLocale: "en",
+    locales: ["en", "pl"],
+    i18next: {
+        // debug is convenient during development to check for missing keys
+        debug: true,
+        initImmediate: false,
+        // backend: {
+        //   loadPath: './src/locales/{{lng}}.yml',
+        // },
+        detection: {}, // Default detection settings
+      },
+      i18nextPlugins: {
+        fsBackend: 'i18next-fs-backend',
+        LanguageDetector: 'i18next-browser-languagedetector',
+      },
   };

package/astro-i18next.config.ts

@@ -1,11 +1,11 @@
-import type { AstroI18nextConfig } from "astro-i18next";
-
-const config: AstroI18nextConfig = {
-  defaultLocale: "en",
-  locales: ["en", "pl"],
-  i18nextServer: {
-    debug: true,
-  },
-};
-
+import type { AstroI18nextConfig } from "astro-i18next";
+
+const config: AstroI18nextConfig = {
+  defaultLocale: "en",
+  locales: ["en", "pl"],
+  i18nextServer: {
+    debug: true,
+  },
+};
+
 export default config;