spoko-design-system 0.9.3 → 0.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. package/.astro/settings.json +4 -4
  2. package/.astro/types.d.ts +1 -1
  3. package/.claude/settings.local.json +2 -1
  4. package/.github/dependabot.yml +11 -11
  5. package/.github/todo.yml +3 -3
  6. package/.github/workflows/deploy.yml +39 -39
  7. package/.stackblitzrc +5 -5
  8. package/.vscode/extensions.json +5 -5
  9. package/.vscode/launch.json +11 -11
  10. package/.vscode/settings.json +5 -5
  11. package/LICENSE +21 -21
  12. package/README.md +116 -116
  13. package/astro-i18next.config.mjs +17 -17
  14. package/astro-i18next.config.ts +10 -10
  15. package/astro.config.mjs +86 -86
  16. package/dev-dist/sw.js +91 -91
  17. package/dev-dist/workbox-c676b6d3.js +3391 -3391
  18. package/icon.config.ts +310 -310
  19. package/index.ts +70 -70
  20. package/package.json +124 -124
  21. package/public/arrow-bottom.svg +7 -7
  22. package/public/fonts/lg.svg +53 -53
  23. package/public/fonts/vwhead-bold-demo.html +549 -549
  24. package/public/fonts/vwhead-regular-demo.html +549 -549
  25. package/public/fonts/vwtext-bold-demo.html +549 -549
  26. package/public/fonts/vwtext-regular-demo.html +549 -549
  27. package/public/github.svg +3 -3
  28. package/public/grid_dot.svg +4 -4
  29. package/public/linkedin.svg +44 -44
  30. package/public/locales/en/translation.json +12 -12
  31. package/public/locales/pl/translation.json +12 -12
  32. package/public/make-scrollable-code-focusable.js +3 -3
  33. package/public/pagefind.yml +3 -3
  34. package/public/polo.blue.svg +29 -29
  35. package/public/spoko.space.svg +71 -71
  36. package/public/twitter.svg +46 -46
  37. package/renovate.json +6 -6
  38. package/sandbox.config.json +11 -11
  39. package/src/MyComponent.astro +8 -8
  40. package/src/components/Badge.vue +19 -19
  41. package/src/components/Badges.vue +21 -21
  42. package/src/components/Breadcrumbs.vue +94 -94
  43. package/src/components/Button.vue +101 -101
  44. package/src/components/ButtonCopy.astro +183 -183
  45. package/src/components/ButtonCopy.vue +36 -36
  46. package/src/components/Card.astro +27 -27
  47. package/src/components/Carousel.astro +26 -26
  48. package/src/components/Category/CategoriesCarousel.astro +101 -101
  49. package/src/components/Category/CategoryDetails.astro +169 -169
  50. package/src/components/Category/CategoryLink.vue +28 -28
  51. package/src/components/Category/CategorySidebarToggler.vue +9 -9
  52. package/src/components/Category/CategoryTile.astro +37 -37
  53. package/src/components/Category/CategoryViewToggler.astro +89 -89
  54. package/src/components/Category/SubCategoryLink.vue +19 -19
  55. package/src/components/Copyright.astro +12 -12
  56. package/src/components/Date.astro +7 -7
  57. package/src/components/Faq.astro +33 -33
  58. package/src/components/FaqItem.astro +80 -80
  59. package/src/components/FeaturesList.vue +37 -37
  60. package/src/components/FuckRussia.vue +62 -62
  61. package/src/components/HandDrive.astro +29 -29
  62. package/src/components/Header/Header.astro +210 -210
  63. package/src/components/Header/SkipToContent.astro +1 -1
  64. package/src/components/Headline.vue +87 -87
  65. package/src/components/Image.astro +30 -30
  66. package/src/components/{layout → Layout}/CallToAction.astro +52 -52
  67. package/src/components/{layout → Layout}/Container.astro +7 -7
  68. package/src/components/{layout → Layout}/Header.astro +80 -80
  69. package/src/components/LeftSidebar.astro +53 -53
  70. package/src/components/MainColors.vue +22 -22
  71. package/src/components/MainInput.vue +15 -15
  72. package/src/components/Modal.astro +27 -27
  73. package/src/components/PageContent.astro +5 -5
  74. package/src/components/PartNumber.vue +27 -27
  75. package/src/components/Post/PostCategories.astro +41 -41
  76. package/src/components/Post/PostCategories.vue +30 -30
  77. package/src/components/PostHeader.astro +103 -103
  78. package/src/components/PrCode.vue +141 -141
  79. package/src/components/Product/ProductButton.vue +18 -18
  80. package/src/components/Product/ProductCarousel.astro +35 -35
  81. package/src/components/Product/ProductEngineType.vue +42 -42
  82. package/src/components/Product/ProductImage.astro +40 -40
  83. package/src/components/Product/ProductLink.astro +101 -101
  84. package/src/components/Product/ProductLink.vue +59 -59
  85. package/src/components/Product/ProductLinkInfo.astro +37 -37
  86. package/src/components/Product/ProductNumber.astro +60 -60
  87. package/src/components/ProductCarousel.astro +38 -38
  88. package/src/components/ProductCodes.vue +39 -39
  89. package/src/components/ProductDetailName.vue +52 -52
  90. package/src/components/ProductDetailsList.vue +216 -216
  91. package/src/components/ProductTile.astro +48 -48
  92. package/src/components/Quote.vue +23 -23
  93. package/src/components/ReloadPrompt.astro +50 -50
  94. package/src/components/SlimBanner.vue +72 -72
  95. package/src/components/Table.vue +32 -32
  96. package/src/components/TableOfContents.astro +15 -15
  97. package/src/components/Translations.vue +23 -23
  98. package/src/components/flags/FlagPL.vue +3 -3
  99. package/src/components/flags/FlagUA.vue +2 -2
  100. package/src/config.ts +56 -56
  101. package/src/design.config.ts +98 -98
  102. package/src/env.d.ts +6 -6
  103. package/src/layouts/Layout.astro +61 -61
  104. package/src/layouts/MainLayout.astro +81 -81
  105. package/src/layouts/partials/FooterCommon.astro +4 -4
  106. package/src/layouts/partials/HeadCommon.astro +44 -44
  107. package/src/layouts/partials/HeadSEO.astro +41 -41
  108. package/src/pages/components/badges.mdx +57 -57
  109. package/src/pages/components/breadcrumbs.mdx +139 -139
  110. package/src/pages/components/buttons.mdx +360 -360
  111. package/src/pages/components/card.mdx +294 -294
  112. package/src/pages/components/carousel.mdx +62 -62
  113. package/src/pages/components/copyright.mdx +42 -42
  114. package/src/pages/components/details-list.mdx +115 -115
  115. package/src/pages/components/features-list.mdx +37 -37
  116. package/src/pages/components/flags.mdx +49 -49
  117. package/src/pages/components/fuck-russia.mdx +39 -39
  118. package/src/pages/components/hand-drive.mdx +38 -38
  119. package/src/pages/components/headline.mdx +137 -137
  120. package/src/pages/components/icons.astro +135 -135
  121. package/src/pages/components/image.mdx +513 -513
  122. package/src/pages/components/input.mdx +367 -367
  123. package/src/pages/components/jumbotron.mdx +359 -359
  124. package/src/pages/components/modal.mdx +64 -64
  125. package/src/pages/components/post-header.mdx +64 -64
  126. package/src/pages/components/pr-code.mdx +65 -65
  127. package/src/pages/components/product-number.mdx +58 -58
  128. package/src/pages/components/product-tile.mdx +51 -51
  129. package/src/pages/components/quote.mdx +33 -33
  130. package/src/pages/components/slimbanner.mdx +35 -35
  131. package/src/pages/components/table.mdx +108 -108
  132. package/src/pages/core/colors.mdx +10 -10
  133. package/src/pages/core/grid.mdx +89 -89
  134. package/src/pages/core/introduction.mdx +77 -77
  135. package/src/pages/core/shadows.astro +20 -20
  136. package/src/pages/core/typography.astro +49 -49
  137. package/src/pages/index.astro +133 -133
  138. package/src/pages/patterns/introduction.mdx +60 -60
  139. package/src/pwa.ts +12 -12
  140. package/src/styles/_variables.scss +70 -70
  141. package/src/styles/base/base.css +184 -184
  142. package/src/styles/base/grid.css +92 -92
  143. package/src/styles/base/typography.css +70 -70
  144. package/src/styles/content.css +73 -73
  145. package/src/styles/main.css +7 -7
  146. package/src/types/Product.ts +31 -31
  147. package/src/types/astro.d.ts +3 -3
  148. package/src/utils/product/getPriceFormatted.ts +15 -15
  149. package/src/utils/product/getProductChecklist.ts +17 -17
  150. package/src/utils/product/useFormatProductNumber.ts +41 -41
  151. package/src/utils/seo/getShorterDescription.ts +14 -14
  152. package/src/utils/text/formatDate.ts +5 -5
  153. package/src/utils/text/formatLocaleNumber.ts +6 -6
  154. package/src/utils/text/formatPad.ts +12 -12
  155. package/src/utils/text/getNumberFormatted.ts +33 -33
  156. package/src/utils/text/getTranslatedLink.ts +5 -5
  157. package/src/utils/text.ts +19 -19
  158. package/tailwind.config.cjs +8 -8
  159. package/tsconfig.json +28 -28
  160. package/uno-config/index.ts +268 -268
  161. package/uno-config/theme/breakpoints.ts +9 -9
  162. package/uno-config/theme/colors.ts +64 -64
  163. package/uno-config/theme/dimensions.ts +17 -17
  164. package/uno-config/theme/effects.ts +14 -14
  165. package/uno-config/theme/grid.ts +10 -10
  166. package/uno-config/theme/index.ts +28 -28
  167. package/uno-config/theme/shortcuts/buttons.ts +53 -53
  168. package/uno-config/theme/shortcuts/components.ts +123 -123
  169. package/uno-config/theme/shortcuts/index.ts +20 -20
  170. package/uno-config/theme/shortcuts/layout.ts +74 -74
  171. package/uno-config/theme/typography.ts +29 -29
  172. package/uno.config.ts +2 -2
@@ -1,5 +1,5 @@
1
- {
2
- "_variables": {
3
- "lastUpdateCheck": 1757938917015
4
- }
1
+ {
2
+ "_variables": {
3
+ "lastUpdateCheck": 1757938917015
4
+ }
5
5
  }
package/.astro/types.d.ts CHANGED
@@ -1 +1 @@
1
- /// <reference types="astro/client" />
1
+ /// <reference types="astro/client" />
@@ -4,7 +4,8 @@
4
4
  "Bash(git remote get-url:*)",
5
5
  "Bash(npm run dev:*)",
6
6
  "Bash(tasklist)",
7
- "Bash(findstr:*)"
7
+ "Bash(findstr:*)",
8
+ "Bash(git add:*)"
8
9
  ],
9
10
  "deny": [],
10
11
  "ask": []
@@ -1,11 +1,11 @@
1
- # To get started with Dependabot version updates, you'll need to specify which
2
- # package ecosystems to update and where the package manifests are located.
3
- # Please see the documentation for all configuration options:
4
- # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5
-
6
- version: 2
7
- updates:
8
- - package-ecosystem: "" # See documentation for possible values
9
- directory: "/" # Location of package manifests
10
- schedule:
11
- interval: "weekly"
1
+ # To get started with Dependabot version updates, you'll need to specify which
2
+ # package ecosystems to update and where the package manifests are located.
3
+ # Please see the documentation for all configuration options:
4
+ # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5
+
6
+ version: 2
7
+ updates:
8
+ - package-ecosystem: "" # See documentation for possible values
9
+ directory: "/" # Location of package manifests
10
+ schedule:
11
+ interval: "weekly"
package/.github/todo.yml CHANGED
@@ -1,3 +1,3 @@
1
- - name: todo-issue
2
- uses: DerJuulsn/todo-issue@v1.1.4
3
-
1
+ - name: todo-issue
2
+ uses: DerJuulsn/todo-issue@v1.1.4
3
+
@@ -1,40 +1,40 @@
1
- name: Deploy to GitHub Pages
2
-
3
- on:
4
- # Trigger the workflow every time you push to the `main` branch
5
- # Using a different branch name? Replace `main` with your branch’s name
6
- push:
7
- branches: [ ma ]
8
- # Allows you to run this workflow manually from the Actions tab on GitHub.
9
- workflow_dispatch:
10
-
11
- # Allow this job to clone the repo and create a page deployment
12
- permissions:
13
- contents: read
14
- pages: write
15
- id-token: write
16
-
17
- jobs:
18
- build:
19
- runs-on: ubuntu-latest
20
- steps:
21
- - name: Checkout your repository using git
22
- uses: actions/checkout@v4
23
- - name: Install, build, and upload your site
24
- uses: withastro/action@v3
25
- with:
26
- pnpm@latest
27
- # path: . # The root location of your Astro project inside the repository. (optional)
28
- # node-version: 18 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
29
- # 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)
30
-
31
- deploy:
32
- needs: build
33
- runs-on: ubuntu-latest
34
- environment:
35
- name: github-pages
36
- url: ${{ steps.deployment.outputs.page_url }}
37
- steps:
38
- - name: Deploy to GitHub Pages
39
- id: deployment
1
+ name: Deploy to GitHub Pages
2
+
3
+ on:
4
+ # Trigger the workflow every time you push to the `main` branch
5
+ # Using a different branch name? Replace `main` with your branch’s name
6
+ push:
7
+ branches: [ ma ]
8
+ # Allows you to run this workflow manually from the Actions tab on GitHub.
9
+ workflow_dispatch:
10
+
11
+ # Allow this job to clone the repo and create a page deployment
12
+ permissions:
13
+ contents: read
14
+ pages: write
15
+ id-token: write
16
+
17
+ jobs:
18
+ build:
19
+ runs-on: ubuntu-latest
20
+ steps:
21
+ - name: Checkout your repository using git
22
+ uses: actions/checkout@v4
23
+ - name: Install, build, and upload your site
24
+ uses: withastro/action@v3
25
+ with:
26
+ pnpm@latest
27
+ # path: . # The root location of your Astro project inside the repository. (optional)
28
+ # node-version: 18 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
29
+ # 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)
30
+
31
+ deploy:
32
+ needs: build
33
+ runs-on: ubuntu-latest
34
+ environment:
35
+ name: github-pages
36
+ url: ${{ steps.deployment.outputs.page_url }}
37
+ steps:
38
+ - name: Deploy to GitHub Pages
39
+ id: deployment
40
40
  uses: actions/deploy-pages@v4
package/.stackblitzrc CHANGED
@@ -1,6 +1,6 @@
1
- {
2
- "startCommand": "npm start",
3
- "env": {
4
- "ENABLE_CJS_IMPORTS": true
5
- }
1
+ {
2
+ "startCommand": "npm start",
3
+ "env": {
4
+ "ENABLE_CJS_IMPORTS": true
5
+ }
6
6
  }
@@ -1,5 +1,5 @@
1
- {
2
- "recommendations": ["astro-build.astro-vscode"],
3
- "unwantedRecommendations": [],
4
- "lokalise.i18n-ally"
5
- }
1
+ {
2
+ "recommendations": ["astro-build.astro-vscode"],
3
+ "unwantedRecommendations": [],
4
+ "lokalise.i18n-ally"
5
+ }
@@ -1,11 +1,11 @@
1
- {
2
- "version": "0.2.0",
3
- "configurations": [
4
- {
5
- "command": "./node_modules/.bin/astro dev",
6
- "name": "Development server",
7
- "request": "launch",
8
- "type": "node-terminal"
9
- }
10
- ]
11
- }
1
+ {
2
+ "version": "0.2.0",
3
+ "configurations": [
4
+ {
5
+ "command": "./node_modules/.bin/astro dev",
6
+ "name": "Development server",
7
+ "request": "launch",
8
+ "type": "node-terminal"
9
+ }
10
+ ]
11
+ }
@@ -1,6 +1,6 @@
1
- {
2
- "i18n-ally.sourceLanguage": "en",
3
- "i18n-ally.keystyle": "nested",
4
- "i18n-ally.localesPaths": "public/locales",
5
- "i18n-ally.sortKeys": true,
1
+ {
2
+ "i18n-ally.sourceLanguage": "en",
3
+ "i18n-ally.keystyle": "nested",
4
+ "i18n-ally.localesPaths": "public/locales",
5
+ "i18n-ally.sortKeys": true,
6
6
  }
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2022 Jordi Enric Roig Ramis
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Jordi Enric Roig Ramis
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,116 +1,116 @@
1
- # Spoko Design System
2
-
3
- ![Version](https://img.shields.io/github/package-json/v/polo-blue/sds)
4
-
5
- SDS is the easiest way to start websites with simple design system. Since Astro is compatible with many frameworks, you can import your components and document them right in the markdown files.
6
- The project is still in the development phase, use at your own risk ;-)
7
- #
8
- Please feel free to fork it, edit it and let me know what do you think about it.
9
-
10
-
11
-
12
- | title | Introduction |
13
- |-------------|--------------------------------|
14
- | description | Docs intro |
15
- | layout | ../../layouts/MainLayout.astro |
16
-
17
-
18
- ## Getting started
19
-
20
- ### Installation
21
-
22
- ```js
23
- pnpm add spoko-design-system
24
- ```
25
-
26
- or just clone the repository.
27
-
28
-
29
-
30
- ### Example:
31
- - https://sds.spoko.space/
32
-
33
- #
34
-
35
- Most of the components from this repository can be seen in my projects:
36
-
37
- - https://catalog.polo.blue/
38
- - https://polo.blue
39
- - https://polo6r.pl
40
-
41
-
42
- ### Feateures
43
- - ⚡️[Vue 3](https://github.com/vuejs/core), [Vite](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/) - born with fastness
44
- - 🎨 [UnoCSS](https://github.com/antfu/unocss) - the instant on-demand atomic CSS engine
45
- - 😃 [astro-icon](https://github.com/natemoo-re/astro-icon) - for local icons, sprites and `@iconify-json/*` sets
46
- - 🍔 [astro-navbar](https://github.com/surjithctly/astro-navbar) - fully responsive and accessible headless navigation bar
47
- - 🌍 [astro-i18next](https://github.com/yassinedoghri/astro-i18next) - Astro integration of i18next
48
- - 🔎 [astro-pagefind](https://github.com/shishkin/astro-pagefind) - Astro integration for Pagefind static site search
49
- - 🗒 [astrojs/mdx](https://github.com/withastro/astro/tree/main/packages/integrations/mdx/) - markdown support
50
- - 📦 [astro-compress](https://github.com/astro-community/AstroCompress) - compression utilities to your Astro project
51
- - 📲 [PWA](https://github.com/vite-pwa/astro) - Zero-config PWA Integration for Astro
52
- - 🏷️ [astro-meta-tags](https://github.com/patrick91/astro-meta-tags) - Meta Tags inside for Astro Dev Toolbar
53
- - 🖨 Static-site generation (SSG)
54
- - 🎡 [Swiper](https://github.com/nolimits4web/swiper) - modern mobile touch slider with hardware accelerated transitions and amazing native behavior
55
- - 🌠 [View Transitions API](https://docs.astro.build/en/guides/view-transitions/#full-site-view-transitions-spa-mode) - [View Transition API](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) - makes it easy to change the DOM in a single step, while creating an animated transition between the two states. It's available in Chrome 111+ ([more details](https://developer.chrome.com/docs/web-platform/view-transitions?hl=en))
56
- - ☁️ Deploy on Netlify
57
-
58
- ### Adding new sections
59
-
60
- Although it's not required, you can create folders for new sections.
61
-
62
- To show the section on the left side navigation, add it to the navigation config file at `src/config.ts`.
63
-
64
-
65
- ```js
66
- export const SIDEBAR = [
67
- { text: "Core", header: true },
68
- { text: "Introduction", link: "/core/introduction" },
69
- ...,
70
- { text: "Components", header: true },
71
- { text: "Buttons", link: "/components/jumbotron" },
72
- ...,
73
- { text: "New section", header: true },
74
- { text: "New component", link: "/new-section/new-component.md" },
75
- ];
76
- ```
77
-
78
- ### Adding new pages
79
-
80
- To add new pages just create an .astro or markdown file in `src/pages/[section]/my-page.mdx`. Remember to add it to the navigation config in `src/config.ts` so it shows up in the left side navigation.
81
-
82
- You're free to organize the pages however you want.
83
-
84
- ### Customizing Core section (colors, typography, shadows...)
85
-
86
- If you want to customize the default colors, typography or shadows you can find the configuration file at uno.config.ts`. I think I have prepared enough shades of blue ;-)
87
-
88
- Feel free to add new pages to the Core section
89
-
90
-
91
- ### Customizing the page layout
92
-
93
- You can find the css for the pages in `src/styles/content.css`.
94
-
95
-
96
- ### Adding your components
97
-
98
- Astro is great for design systems because it allows you to import components from different frameworks like react, vue or svelte.
99
-
100
- To get started check how the `MainButton` component is used in the `src/pages/buttons.mdx` file.
101
-
102
- You can import your component library or create your own and document it easily.
103
-
104
-
105
- ### `.component-preview` utility
106
-
107
- There's a class called `.component-preview` that you can use to wrap your component in a grid, and it will look like this:
108
-
109
- <div class="component-preview">
110
- <button class="text-white bg-blue-lightest px-4 py-2 rounded-md">Your component</button>
111
- </div>
112
-
113
-
114
- ### Have fun!
115
-
116
- Spoko Design System template was made in Poland by **[@spoko.space](https://spoko.space)** for personal and commercial use.
1
+ # Spoko Design System
2
+
3
+ ![Version](https://img.shields.io/github/package-json/v/polo-blue/sds)
4
+
5
+ SDS is the easiest way to start websites with simple design system. Since Astro is compatible with many frameworks, you can import your components and document them right in the markdown files.
6
+ The project is still in the development phase, use at your own risk ;-)
7
+ #
8
+ Please feel free to fork it, edit it and let me know what do you think about it.
9
+
10
+
11
+
12
+ | title | Introduction |
13
+ |-------------|--------------------------------|
14
+ | description | Docs intro |
15
+ | layout | ../../layouts/MainLayout.astro |
16
+
17
+
18
+ ## Getting started
19
+
20
+ ### Installation
21
+
22
+ ```js
23
+ pnpm add spoko-design-system
24
+ ```
25
+
26
+ or just clone the repository.
27
+
28
+
29
+
30
+ ### Example:
31
+ - https://sds.spoko.space/
32
+
33
+ #
34
+
35
+ Most of the components from this repository can be seen in my projects:
36
+
37
+ - https://catalog.polo.blue/
38
+ - https://polo.blue
39
+ - https://polo6r.pl
40
+
41
+
42
+ ### Feateures
43
+ - ⚡️[Vue 3](https://github.com/vuejs/core), [Vite](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/) - born with fastness
44
+ - 🎨 [UnoCSS](https://github.com/antfu/unocss) - the instant on-demand atomic CSS engine
45
+ - 😃 [astro-icon](https://github.com/natemoo-re/astro-icon) - for local icons, sprites and `@iconify-json/*` sets
46
+ - 🍔 [astro-navbar](https://github.com/surjithctly/astro-navbar) - fully responsive and accessible headless navigation bar
47
+ - 🌍 [astro-i18next](https://github.com/yassinedoghri/astro-i18next) - Astro integration of i18next
48
+ - 🔎 [astro-pagefind](https://github.com/shishkin/astro-pagefind) - Astro integration for Pagefind static site search
49
+ - 🗒 [astrojs/mdx](https://github.com/withastro/astro/tree/main/packages/integrations/mdx/) - markdown support
50
+ - 📦 [astro-compress](https://github.com/astro-community/AstroCompress) - compression utilities to your Astro project
51
+ - 📲 [PWA](https://github.com/vite-pwa/astro) - Zero-config PWA Integration for Astro
52
+ - 🏷️ [astro-meta-tags](https://github.com/patrick91/astro-meta-tags) - Meta Tags inside for Astro Dev Toolbar
53
+ - 🖨 Static-site generation (SSG)
54
+ - 🎡 [Swiper](https://github.com/nolimits4web/swiper) - modern mobile touch slider with hardware accelerated transitions and amazing native behavior
55
+ - 🌠 [View Transitions API](https://docs.astro.build/en/guides/view-transitions/#full-site-view-transitions-spa-mode) - [View Transition API](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) - makes it easy to change the DOM in a single step, while creating an animated transition between the two states. It's available in Chrome 111+ ([more details](https://developer.chrome.com/docs/web-platform/view-transitions?hl=en))
56
+ - ☁️ Deploy on Netlify
57
+
58
+ ### Adding new sections
59
+
60
+ Although it's not required, you can create folders for new sections.
61
+
62
+ To show the section on the left side navigation, add it to the navigation config file at `src/config.ts`.
63
+
64
+
65
+ ```js
66
+ export const SIDEBAR = [
67
+ { text: "Core", header: true },
68
+ { text: "Introduction", link: "/core/introduction" },
69
+ ...,
70
+ { text: "Components", header: true },
71
+ { text: "Buttons", link: "/components/jumbotron" },
72
+ ...,
73
+ { text: "New section", header: true },
74
+ { text: "New component", link: "/new-section/new-component.md" },
75
+ ];
76
+ ```
77
+
78
+ ### Adding new pages
79
+
80
+ To add new pages just create an .astro or markdown file in `src/pages/[section]/my-page.mdx`. Remember to add it to the navigation config in `src/config.ts` so it shows up in the left side navigation.
81
+
82
+ You're free to organize the pages however you want.
83
+
84
+ ### Customizing Core section (colors, typography, shadows...)
85
+
86
+ If you want to customize the default colors, typography or shadows you can find the configuration file at uno.config.ts`. I think I have prepared enough shades of blue ;-)
87
+
88
+ Feel free to add new pages to the Core section
89
+
90
+
91
+ ### Customizing the page layout
92
+
93
+ You can find the css for the pages in `src/styles/content.css`.
94
+
95
+
96
+ ### Adding your components
97
+
98
+ Astro is great for design systems because it allows you to import components from different frameworks like react, vue or svelte.
99
+
100
+ To get started check how the `MainButton` component is used in the `src/pages/buttons.mdx` file.
101
+
102
+ You can import your component library or create your own and document it easily.
103
+
104
+
105
+ ### `.component-preview` utility
106
+
107
+ There's a class called `.component-preview` that you can use to wrap your component in a grid, and it will look like this:
108
+
109
+ <div class="component-preview">
110
+ <button class="text-white bg-blue-lightest px-4 py-2 rounded-md">Your component</button>
111
+ </div>
112
+
113
+
114
+ ### Have fun!
115
+
116
+ Spoko Design System template was made in Poland by **[@spoko.space](https://spoko.space)** for personal and commercial use.
@@ -1,18 +1,18 @@
1
- /** @type {import('astro-i18next').AstroI18nextConfig} */
2
- export default {
3
- defaultLocale: "en",
4
- locales: ["en", "pl"],
5
- i18next: {
6
- // debug is convenient during development to check for missing keys
7
- debug: true,
8
- initImmediate: false,
9
- // backend: {
10
- // loadPath: './src/locales/{{lng}}.yml',
11
- // },
12
- detection: {}, // Default detection settings
13
- },
14
- i18nextPlugins: {
15
- fsBackend: 'i18next-fs-backend',
16
- LanguageDetector: 'i18next-browser-languagedetector',
17
- },
1
+ /** @type {import('astro-i18next').AstroI18nextConfig} */
2
+ export default {
3
+ defaultLocale: "en",
4
+ locales: ["en", "pl"],
5
+ i18next: {
6
+ // debug is convenient during development to check for missing keys
7
+ debug: true,
8
+ initImmediate: false,
9
+ // backend: {
10
+ // loadPath: './src/locales/{{lng}}.yml',
11
+ // },
12
+ detection: {}, // Default detection settings
13
+ },
14
+ i18nextPlugins: {
15
+ fsBackend: 'i18next-fs-backend',
16
+ LanguageDetector: 'i18next-browser-languagedetector',
17
+ },
18
18
  };
@@ -1,11 +1,11 @@
1
- import type { AstroI18nextConfig } from "astro-i18next";
2
-
3
- const config: AstroI18nextConfig = {
4
- defaultLocale: "en",
5
- locales: ["en", "pl"],
6
- i18nextServer: {
7
- debug: true,
8
- },
9
- };
10
-
1
+ import type { AstroI18nextConfig } from "astro-i18next";
2
+
3
+ const config: AstroI18nextConfig = {
4
+ defaultLocale: "en",
5
+ locales: ["en", "pl"],
6
+ i18nextServer: {
7
+ debug: true,
8
+ },
9
+ };
10
+
11
11
  export default config;