Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WRXinYue committed Jan 5, 2025
1 parent f8a1dec commit 0164183
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 20 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A simple, personalized, and cute anime-style blog theme ~(∠・ω< )⌒★

<p align="center">
<a href="https://sakura.wrxinyue.org" target="_blank">
<img src="https://valaxy-theme-sakura.s3.bitiful.net/demo/2024-09-29.png" alt="valaxy-theme-sakura" />
<img src="https://valaxy-theme-sakura.s3.bitiful.net/demo%2F2025-01-05.png" alt="valaxy-theme-sakura" />
</a>
</p>

Expand Down Expand Up @@ -54,7 +54,11 @@ export default defineValaxyConfig<ThemeUserConfig>({
theme: 'sakura',

themeConfig: {
banner: {
ui: {
primary: '#ff4e6a',
},

hero: {
title: 'Hello, sakura',
motto: 'You got to put the past behind you before you can move on.',
urls: [
Expand All @@ -69,14 +73,6 @@ export default defineValaxyConfig<ThemeUserConfig>({

<br></details>

In the `styles` directory, add the following to the `index.scss` file:

```scss
@use 'valaxy-theme-sakura/styles/themes/sakura/index.scss' as *;
```

Sakura prioritizes lightweight design, so the default configuration does not include Sakura's styles. For details, see [Theming](https://sakura.valaxy.site/styles/theming).

## Updates

As versions continue to evolve, we recommend updating [valaxy](https://github.com/YunYouJun/valaxy) and [valaxy-theme-sakura](https://github.com/WRXinYue/valaxy-theme-sakura) to ensure the theme and framework are up-to-date. More exciting features may await your discovery in the future.
Expand Down
16 changes: 6 additions & 10 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

<p align="center">
<a href="https://sakura.wrxinyue.org" target="_blank">
<img src="https://valaxy-theme-sakura.s3.bitiful.net/demo/2024-09-29.png" alt="valaxy-theme-sakura" />
<img src="https://valaxy-theme-sakura.s3.bitiful.net/demo%2F2025-01-05.png" alt="valaxy-theme-sakura" />
</a>
</p>

Expand Down Expand Up @@ -54,7 +54,11 @@ export default defineValaxyConfig<ThemeUserConfig>({
theme: 'sakura',

themeConfig: {
banner: {
ui: {
primary: '#ff4e6a',
},

hero: {
title: 'Hello, sakura',
motto: 'You got to put the past behind you before you can move on.',
urls: [
Expand All @@ -69,14 +73,6 @@ export default defineValaxyConfig<ThemeUserConfig>({

<br></details>

`styles` 目录的 `index.scss` 文件,填入以下内容:

```scss
@use 'valaxy-theme-sakura/styles/themes/sakura/index.scss' as *;
```

Sakura 以轻量化为首要目的在默认配置中没有包含 Sakura 的样式,详情参见[主题化](https://sakura.valaxy.site/styles/theming)

## 更新

随着版本不断迭代,我们建议您更新 [valaxy](https://github.com/YunYouJun/valaxy)[valaxy-theme-sakura](https://github.com/WRXinYue/valaxy-theme-sakura) 的版本,以确保主题和框架保持最新同步。未来或许会有更多有趣的功能等待您去发现
Expand Down

0 comments on commit 0164183

Please sign in to comment.