Skip to content

Commit cffe8f8

Browse files
committed
chore: update doc
1 parent 084dacd commit cffe8f8

File tree

28 files changed

+1018
-941
lines changed

28 files changed

+1018
-941
lines changed

i18n/en/docusaurus-plugin-content-docs/version-2.1/20-concepts/05-styling/34-theming.mdx

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import { KolAlert, KolDetails, KolIndentedText, KolLink, } from '@public-ui/react';
2-
import { KoliBri } from '@site/src/components/KoliBri';
3-
import { Mermaid } from '@site/src/components/Mermaid';
1+
import {KolAlert, KolDetails, KolIndentedText, KolLink,} from '@public-ui/react';
2+
import {KoliBri} from '@site/src/components/KoliBri';
3+
import {Mermaid} from '@site/src/components/Mermaid';
44

55
# Theming
66

@@ -9,9 +9,7 @@ import { Mermaid } from '@site/src/components/Mermaid';
99
</KolAlert>
1010

1111
<p>
12-
The unique feature of <KoliBri/> is the <strong>reference implementation</strong> of components that are <strong>semantically W3C- and
13-
WCAG-compliant</strong> from the ground up and thus <strong>completely accessible</strong> regarding assistive support. All components are implemented
14-
as <KolLink _label="Web Components" _href="https://developer.mozilla.org/en-US/docs/Web/Web_Components" _target="_blank"/>
12+
The unique feature of <KoliBri /> is the <strong>reference implementation</strong> of components that are <strong>semantically W3C- and WCAG-compliant</strong> from the ground up and thus <strong>completely accessible</strong> regarding assistive support. All components are implemented as <KolLink _label="Web Components" _href="https://developer.mozilla.org/en-US/docs/Web/Web_Components" _target="_blank" />
1513
and are therefore reusable in all web-based projects. In the following figure, these components are represented by the gray-dashed shapes in the center.
1614
</p>
1715
<p>
@@ -26,24 +24,15 @@ import { Mermaid } from '@site/src/components/Mermaid';
2624
/>
2725

2826
<p>
29-
In the first release (v1.0) <KoliBri/> had directly implemented the individualization of the standard design using
30-
so-called <strong><KolLink _label="CSS-Properties" _href="https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties"
31-
_target="_blank"/></strong>
32-
(<KolLink _label="Design-Tokens" _href="https://uxdesign.cc/design-tokens-for-dummies-8acebf010d71" _target="_blank"/>, <KolLink _label="Tailwind CSS"
33-
_href="https://tailwindcss.com"
34-
_target="_blank"/>). With the
35-
implementation of further themes, however, we have found that we would have to introduce more and more CSS-Properties to be able to implement the flexibility
36-
for the desired design/UX (Corporate Design/Style guide). In
37-
case of doubt, a separate property would have to be provided for each customizability. The example of the <KolLink _label="MUI-Button CSS"
38-
_href="https://mui.com/material-ui/api/button/#css"
39-
_target="_blank"/> shows well how the CSS
40-
properties (design tokens) become more and more.
27+
In the first release (v1.0) <KoliBri /> had directly implemented the individualization of the standard design using
28+
so-called <strong><KolLink _label="CSS-Properties" _href="https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties" _target="_blank" /></strong>
29+
(<KolLink _label="Design-Tokens" _href="https://uxdesign.cc/design-tokens-for-dummies-8acebf010d71" _target="_blank" />, <KolLink _label="Tailwind CSS" _href="https://tailwindcss.com" _target="_blank" />). With the implementation of further themes, however, we have found that we would have to introduce more and more CSS-Properties to be able to implement the flexibility for the desired design/UX (Corporate Design/Style guide). In
30+
case of doubt, a separate property would have to be provided for each customizability. The example of the <KolLink _label="MUI-Button CSS" _href="https://mui.com/material-ui/api/button/#css" _target="_blank" /> shows well how the CSS properties (design tokens) become more and more.
4131
</p>
4232
<p>
4333
<KolIndentedText>
4434
<strong>
45-
2. We have completely decoupled the whole CSS from the components (like <KolLink _label="Styled-Components" _href="https://styled-components.com"
46-
_target="_blank"/>).
35+
2. We have completely decoupled the whole CSS from the components (like <KolLink _label="Styled-Components" _href="https://styled-components.com" _target="_blank" />).
4736
</strong>
4837
</KolIndentedText>
4938
</p>
@@ -104,7 +93,7 @@ stateDiagram-v2
10493
<p>
10594
For example, the UI/UX team specifies the components of their design system with Figma. When the specification is
10695
transferred to implementation, the design is “transferred” to the basic components in the form of pure CSS using the
107-
<KolLink _label="KoliBri-Designer" _href="/en/docs/concepts/styling/designer"/>. If customizability is desired in your
96+
<KolLink _label="KoliBri-Designer" _href="/en/docs/concepts/styling/designer" />. If customizability is desired in your
10897
design system, CSS properties or design tokens can be defined in the Designer for this purpose. So that the own theme
10998
can be shared across projects, the theme is packaged in an NPM package and can be made available via any registry.
11099
</p>
@@ -126,12 +115,6 @@ stateDiagram-v2
126115
<p>
127116
Own specific components, which are not provided by KoliBri and unfortunately do not fit to the KoliBri component
128117
variety, can be built in own component libraries and maintained independently. For this purpose, we offer the
129-
so-called <strong>KoliBri-Factory</strong> (Stack) (see{' '}
130-
<KolLink
131-
_label="Modularization"
132-
_href="/en/docs/concepts/architecture#advanced"
133-
_target="_blank"
134-
/>
135-
).
118+
so-called <strong>KoliBri-Factory</strong> (Stack) (see <KolLink _label="Modularization" _href="https://github.com/public-ui/kolibri/blob/main/docs/ARCHITECTURE.md#erweitert" _target="_blank" />).
136119
</p>
137120
</KolAlert>

package.json

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -30,32 +30,32 @@
3030
"regenerate:version": "rimraf i18n/en/docusaurus-plugin-content-docs/version-2.0 versioned_docs/version-2.0 versioned_readmes/2.0 versioned_sidebars/version-2.0-sidebars.json && npm run docusaurus docs:version 2.0"
3131
},
3232
"dependencies": {
33-
"@docusaurus/core": "3.4.0",
34-
"@docusaurus/eslint-plugin": "3.4.0",
35-
"@docusaurus/plugin-client-redirects": "3.4.0",
36-
"@docusaurus/plugin-ideal-image": "3.4.0",
37-
"@docusaurus/plugin-pwa": "3.4.0",
38-
"@docusaurus/preset-classic": "3.4.0",
39-
"@docusaurus/theme-mermaid": "3.4.0",
40-
"@docusaurus/theme-translations": "3.4.0",
33+
"@docusaurus/core": "3.5.2",
34+
"@docusaurus/eslint-plugin": "3.5.2",
35+
"@docusaurus/plugin-client-redirects": "3.5.2",
36+
"@docusaurus/plugin-ideal-image": "3.5.2",
37+
"@docusaurus/plugin-pwa": "3.5.2",
38+
"@docusaurus/preset-classic": "3.5.2",
39+
"@docusaurus/theme-mermaid": "3.5.2",
40+
"@docusaurus/theme-translations": "3.5.2",
4141
"@leanup/form": "1.3.54",
42-
"@mdx-js/react": "3.0.1",
42+
"@mdx-js/react": "3.1.0",
4343
"@monaco-editor/react": "4.6.0",
44-
"@public-ui/components": "2.1.8",
45-
"@public-ui/react": "2.1.8",
46-
"@public-ui/themes": "2.1.8",
44+
"@public-ui/components": "2.1.9",
45+
"@public-ui/react": "2.1.9",
46+
"@public-ui/themes": "2.1.9",
4747
"classnames": "2.5.1",
48-
"docusaurus-lunr-search": "3.4.0",
49-
"mermaid": "10.9.1",
48+
"docusaurus-lunr-search": "3.5.0",
49+
"mermaid": "10.9.3",
5050
"prettier": "2.8.8",
5151
"react": "18.3.1",
5252
"react-dom": "18.3.1",
53-
"read-excel-file": "5.8.5"
53+
"read-excel-file": "5.8.6"
5454
},
5555
"devDependencies": {
56-
"@docsearch/react": "3.6.1",
57-
"@docusaurus/module-type-aliases": "3.4.0",
58-
"@docusaurus/types": "3.4.0",
56+
"@docsearch/react": "3.6.2",
57+
"@docusaurus/module-type-aliases": "3.5.2",
58+
"@docusaurus/types": "3.5.2",
5959
"@tsconfig/docusaurus": "2.0.3",
6060
"@types/prettier": "2.7.3",
6161
"@typescript-eslint/eslint-plugin": "7.18.0",
@@ -65,19 +65,19 @@
6565
"depcheck": "1.4.7",
6666
"docusaurus-plugin-sass": "0.2.5",
6767
"eslint": "8.57.1",
68-
"eslint-plugin-jsx-a11y": "6.10.0",
68+
"eslint-plugin-jsx-a11y": "6.10.2",
6969
"eslint-plugin-mdx": "3.1.5",
70-
"eslint-plugin-react": "7.36.1",
70+
"eslint-plugin-react": "7.37.2",
7171
"html-minifier-terser": "7.2.0",
7272
"npm-check-updates": "16.14.20",
7373
"npm-run-all": "4.1.5",
7474
"postcss": "8.4.47",
7575
"prop-types": "15.8.1",
7676
"rimraf": "3.0.2",
77-
"sass": "1.79.3",
78-
"tailwindcss": "3.4.13",
77+
"sass": "1.80.4",
78+
"tailwindcss": "3.4.14",
7979
"ts-prune": "0.10.3",
80-
"typescript": "5.6.2"
80+
"typescript": "5.6.3"
8181
},
8282
"browserslist": {
8383
"production": [

0 commit comments

Comments
 (0)