Skip to content

Latest commit

 

History

History
126 lines (94 loc) · 5.79 KB

README.md

File metadata and controls

126 lines (94 loc) · 5.79 KB
Raw

valaxy-theme-sakura

A simple, personalized, and cute anime-style blog theme ～(∠・ω< )⌒★

NPM version Downloads License Open in StackBlitz

valaxy-theme-sakura


English | 简体中文
We are updating the theme documentation and examples, expected to be released in version `v0.7.0` on the Valaxy Theme Gallery
Live Demo | Documentation | Theme Sites

Getting Started

Tip

If you are new to Valaxy, it's recommended to check the installation documentation for the setup process. For detailed installation instructions, refer to the installation documentation for valaxy-theme-sakura.

pnpm add valaxy-theme-sakura
valaxy.config.ts

For detailed configuration and explanations, see Theme Configuration.

import { defineConfig } from 'valaxy'
import type { ThemeUserConfig } from 'valaxy-theme-sakura'

export default defineValaxyConfig<ThemeUserConfig>({
  theme: 'sakura',

  themeConfig: {
    banner: {
      title: 'Hello, sakura',
      motto: 'You got to put the past behind you before you can move on.',
      urls: [
        'https://wrxinyue-images.s3.bitiful.net/wallpaper/Genshin Impact - Yae Miko (4) Cybust PC.mp4',
        'https://wrxinyue-images.s3.bitiful.net/pc-wallpaper/wallhaven-yxwy7k.jpg'
      ],
      style: 'filter-dot',
    },
  },
})


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

@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.

Updates

As versions continue to evolve, we recommend updating valaxy and valaxy-theme-sakura to ensure the theme and framework are up-to-date. More exciting features may await your discovery in the future.

pnpm add valaxy@latest
pnpm add valaxy-theme-sakura@latest

Integration Plugins

Note

To keep the project lightweight, we will not add too many unnecessary dependencies. You can install the plugins you need. For more plugins, visit the Valaxy Plugin Gallery.

Plugin Description
valaxy-addon-hitokoto Hitokoto Plugin
valaxy-addon-vercount Website Statistics Plugin
valaxy-addon-waline Waline Comment Component

Contribution

We welcome anyone to contribute. If you have good ideas or suggestions, feel free to share them. For details, please see CONTRIBUTING.md.

Other

The related task list has been migrated to valaxy-theme-sakura projects.

Acknowledgments

This project is heavily inspired by the following awesome projects.

And thanks to all the contributors on GitHub!

License

Important

valaxy-theme-sakura does not copy any source code from wordpress-theme-sakura. valaxy-theme-sakura is inspired by the styles of wordpress-theme-sakura and implements theming and component design.

MIT License © 2024-PRESENT WRXinYue