Skip to content

Commit

Permalink
doc: add descriptions for Adapted Styles && add other language support
Browse files Browse the repository at this point in the history
  • Loading branch information
hakadao committed Mar 22, 2024
1 parent 31af6ce commit 14ce824
Show file tree
Hide file tree
Showing 4 changed files with 202 additions and 2 deletions.
64 changes: 64 additions & 0 deletions src/styles/adaptedStyles/README-cmn_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Adapted Styles

这里放置暗色模式的 CSS 或更改主题颜色。

`index.ts` 中,我们将编写一些正则表达式,以匹配特定页面上使用的样式。

## 样式文件编写风格

``` scss
.bewly-design.pageName {
// 实现对页面的特定修改,例如微调布局,将这些样式放在这里
.right-side-bar .catalog {
line-height: 3em;
}

...

// #region theme color adaption part
// 通过在 `:not()` 中编写一个不存在的选择器来增加内部样式的优先级。
:not(fdjslfds) {
a, b, c {
color: var(--bew-theme-color);
}

d, e, f {
// 请注意,使用 `!important` 应该是最后万不得已的手段
color: var(--bew-theme-color) !important;
}

g, h, i {
background-color: var(--bew-theme-color);
}

j, k, l {
background-color: var(--bew-theme-color) !important;
}

...
}
// #endregion

// #region dark mode adaption part
&.dark {
aa, bb, cc {
color: var(--bew-text-1);
}

dd, ee, ff {
color: var(--bew-text-1) !important;
}

...
}
// #endregion
}
```

## 为什么要使用上述的编写风格?

也许你会对为什么应该遵循建议的编写风格感到困惑,所以在这里我们将解释一下。
由于这并不是按照页面特定的初始样式编写的,并且页面已经有了原始样式,你不能简单地写入像 `xxx {border: 1px solid white; color: black}` 这样的 CSS。
遵循前面的这种编写风格会使得维护暗模式样式变得困难。这是因为暗色模式主要需要改变文本颜色、背景颜色或边框颜色。

根据字体颜色、背景颜色和边框颜色高效地进行分组,并通过将适当的选择器放在一起统一方法,以便进行轻松维护。在必要时,只需调整相应样式中的相应选择器。
64 changes: 64 additions & 0 deletions src/styles/adaptedStyles/README-cmn_TW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Adapted Styles

在這裡放置深色模式的 CSS 或更改主題顏色。

`index.ts` 中,我們將編寫一些正規表達式來匹配特定頁面上使用的樣式。

## 樣式表檔案撰寫風格

``` scss
.bewly-design.pageName {
// 在此處實施對頁面的特定修改,例如調整佈局,並將那些樣式放在這裡。
.right-side-bar .catalog {
line-height: 3em;
}

...

// #region theme color adaption part
// 透過在 `:not()` 中寫入一個不存在的選取器來提高內部樣式的優先級。
:not(fdjslfds) {
a, b, c {
color: var(--bew-theme-color);
}

d, e, f {
// 請注意,使用 `!important` 應該是最後萬不得已的手段
color: var(--bew-theme-color) !important;
}

g, h, i {
background-color: var(--bew-theme-color);
}

j, k, l {
background-color: var(--bew-theme-color) !important;
}

...
}
// #endregion

// #region dark mode adaption part
&.dark {
aa, bb, cc {
color: var(--bew-text-1);
}

dd, ee, ff {
color: var(--bew-text-1) !important;
}

...
}
// #endregion
}
```

## 何解使用上述之撰寫風格?

您可能會對為什麼應該遵循建議的撰寫風格感到困惑,因此我們在這裡稍作解釋。
由於這並非以該頁面特有的起始样式所撰寫,而且該頁面已經有了原始樣式,您不能僅僅像這樣寫 CSS `xxx {border: 1px solid white; color: black}`
遵循前面的這種撰寫風格使得維持暗模式風格變得困難。這是因為深色模式主要需要更改字型色彩、背景色彩或框線色彩。

根據字型色彩、背景色彩和框線色彩將顏色進行分組是非常高效的,且透過將相應的選取器放在一起以統一方法便於維護。必要時,只需調整相應樣式中的相應選取器即可。
64 changes: 64 additions & 0 deletions src/styles/adaptedStyles/README-jyut.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Adapted Styles

喺呢度會擺啲深色模式同埋變更佈景色嘅 CSS

`index.ts`,我哋會寫一啲正則表達式令到寫嘅樣式夾返特定嘅頁面。

## 樣式檔書寫風格

``` scss
.bewly-design.pageName {
// 喺當前嘅頁面進行特別嘅修改,就好似你係噉以執吓個佈局,將嗰啲嘢擺晒落呢度
.right-side-bar .catalog {
line-height: 3em;
}

...

// #region theme color adaption part
// 用 `:not()` 選取選取唔存在嘅元素愛嚟提高喺呢度入邊嘅優先權
:not(fdjslfds) {
a, b, c {
color: var(--bew-theme-color);
}

d, e, f {
// 請注意用 `!important` 係你最後嘅選擇
color: var(--bew-theme-color) !important;
}

g, h, i {
background-color: var(--bew-theme-color);
}

j, k, l {
background-color: var(--bew-theme-color) !important;
}

...
}
// #endregion

// #region dark mode adaption part
&.dark {
aa, bb, cc {
color: var(--bew-text-1);
}

dd, ee, ff {
color: var(--bew-text-1) !important;
}

...
}
// #endregion
}
```

## 點解要用上高嘅書寫風格?

你可能唔係幾明點解要跟住建議嘅書寫風格,所以而家我哋慢慢解釋。
事關你唔係用呢個網頁最初嘅樣式嚟寫,而呢個網頁不溜就已經有咗自己嘅樣式,所以你唔可以直接噉寫 CSS 就好似 `xxx {border: 1px solid white; color: black}` 噉。
學似啱啱嘅書寫風格後續會勁難維護深色模式。因為深色模式主要係改文本顏色、背景顏色或者邊框顏色呢啲嚟達到效果。

將啲顏色按照字體顏色、背景顏色同埋邊框顏色噉樣分類,再將適合嘅選取器擺埋一齊,用統一嘅處理手法嚟管理,噉樣做會提高效率同埋易啲維護。之後需要執吓佢嗰陣,淨係需要就住相對應嘅樣式風格嚟調整返相對應嘅選取器就得嘞。
12 changes: 10 additions & 2 deletions src/styles/adaptedStyles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Here, place the CSS for dark mode or change the theme color.

In `index.ts`, we will write some regex rules to match the style used on specific page.
In `index.ts`, we will write some regex rules to match the style used on a specific page.

## Style File Writing Style

Expand All @@ -16,7 +16,7 @@ In `index.ts`, we will write some regex rules to match the style used on specifi
...

// #region theme color adaption part
// Increase the priority of the style inside by writing a non-existent selector in :not()
// Increase the priority of the style inside by writing a non-existent selector in `:not()`
:not(fdjslfds) {
a, b, c {
color: var(--bew-theme-color);
Expand Down Expand Up @@ -54,3 +54,11 @@ In `index.ts`, we will write some regex rules to match the style used on specifi
// #endregion
}
```

## Why use the above writing style?

You might be confused about why you should follow the suggested writing style, so here we will explain a bit.
Since this isn't written in a pure style specific to the page, and the page already has an original style, you can't simply write CSS like `xxx {border: 1px solid white; color: black}`.
Following this writing style makes it hard to maintain the dark mode style. This is because dark mode primarily requires changes to the text color, background color, or border color.

It's efficient to group colors according to font color, background color, and border color, and to unify the approach by placing the appropriate selectors together for easy maintenance. When necessary, just adjust the corresponding selectors in the corresponding styles.

0 comments on commit 14ce824

Please sign in to comment.