Skip to content

Commit

Permalink
docs: introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
AuroraZiling committed May 25, 2024
1 parent 462acf5 commit 733a690
Show file tree
Hide file tree
Showing 101 changed files with 374 additions and 42 deletions.
29 changes: 0 additions & 29 deletions docs/docs/.vitepress/config.mts

This file was deleted.

124 changes: 124 additions & 0 deletions docs/docs/.vitepress/config/en.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
import { defineConfig } from 'vitepress'

export const en = defineConfig({
description: "A Desktop UI Library for Avalonia",
themeConfig: {
nav: [
{ text: 'Home', link: '/' },
{ text: 'Documentation', link: '/documentation' }
],

sidebar: [
{
text: 'Get Started',
items: [
{ text: 'Introduction', link: '/documentation/getting-started/introduction' },
{ text: 'Installation', link: '/documentation/getting-started/installation' },
{ text: 'Launch', link: '/documentation/getting-started/launch' },
]
},
{
text: 'Theming',
items: [
{ text: 'Basic', link: '/documentation/theming/basic' },
{ text: 'Light & Dark', link: '/documentation/theming/theme' },
{ text: 'Color', link: '/documentation/theming/theme-color' },
]
},
{
text: 'Controls',
items: [
{
text: 'Navigation',
items: [
{ text: 'SideMenu', link: '/documentation/controls/navigation/sidemenu' },
]
},
{
text: 'Layout',
items: [
{ text: 'GlassCard', link: '/documentation/controls/layout/glasscard' },
{ text: 'TabControl', link: '/documentation/controls/layout/tabcontrol' },
{ text: 'StackPage', link: '/documentation/controls/layout/stackpage' },
{ text: 'SettingsLayout', link: '/documentation/controls/layout/settingslayout' },
{ text: 'SukiWindow', link: '/documentation/controls/layout/sukiwindow' },
]
},
{
text: 'Inputs',
items: [
{ text: 'Button', link: '/documentation/controls/inputs/button' },
{ text: 'DropDownButton', link: '/documentation/controls/inputs/dropdownbutton' },
{ text: 'ToggleSwitch', link: '/documentation/controls/inputs/toggleswitch' },
{ text: 'ToggleButton', link: '/documentation/controls/inputs/togglebutton' },
{ text: 'Slider', link: '/documentation/controls/inputs/slider' },
{ text: 'ComboBox', link: '/documentation/controls/inputs/combobox' },
{ text: 'NumericUpDown', link: '/documentation/controls/inputs/numericupdown' },
{ text: 'TextBox', link: '/documentation/controls/inputs/textbox' },
{ text: 'CheckBox', link: '/documentation/controls/inputs/checkbox' },
{ text: 'RadioButton', link: '/documentation/controls/inputs/radiobutton' },
{ text: 'ContextMenu', link: '/documentation/controls/inputs/contextmenu' },
]
},
{
text: 'Text',
items: [
{ text: 'AutoCompleteBox', link: '/documentation/controls/text/autocompletebox' },
{ text: 'TextBox', link: '/documentation/controls/text/textbox' },
]
},
{
text: 'Date & Time',
items: [
{ text: 'Calendar', link: '/documentation/controls/datetime/calendar' },
{ text: 'DatePicker', link: '/documentation/controls/datetime/datepicker' },
]
},
{
text: 'Progress',
items: [
{ text: 'WaveProgress', link: '/documentation/controls/progress/waveprogress' },
{ text: 'Stepper', link: '/documentation/controls/progress/stepper' },
{ text: 'CircleProgressBar', link: '/documentation/controls/progress/circleprogressbar' },
{ text: 'Loading', link: '/documentation/controls/progress/loading' },
{ text: 'ProgressBar', link: '/documentation/controls/progress/progressbar' },
]
},
{
text: 'Data Presentation',
items: [
{ text: 'DataGrid', link: '/documentation/controls/data/datagrid' },
{ text: 'ListBox', link: '/documentation/controls/data/listbox' },
{ text: 'TreeView', link: '/documentation/controls/data/treeview' },
{ text: 'GroupBox', link: '/documentation/controls/data/groupbox' },
{ text: 'BusyArea', link: '/documentation/controls/data/busyarea' },
{ text: 'Expander', link: '/documentation/controls/data/expander' },
]
},
{
text: 'System',
items: [
{ text: 'FilePicker', link: '/documentation/controls/system/filepicker' },
]
}
]
},
{
text: 'Notification',
items: [
{ text: 'Dialog', link: '/documentation/notification/dialog' },
{ text: 'Toast', link: '/documentation/notification/toast' },
{ text: 'MessageBox', link: '/documentation/notification/messagebox' },
]
},
{
text: 'Style',
items: [
{ text: 'Text', link: '/documentation/style/text' },
{ text: 'Color', link: '/documentation/style/color' },
{ text: 'Icon', link: '/documentation/style/icon' },
]
}
]
}
})
12 changes: 12 additions & 0 deletions docs/docs/.vitepress/config/index.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { defineConfig } from 'vitepress'
import { shared } from './shared.mts'
import { en } from './en.mts'
import { zh } from './zh.mts'

export default defineConfig({
...shared,
locales: {
root: { label: 'English', ...en },
zh: { label: '简体中文', ...zh }
}
})
13 changes: 13 additions & 0 deletions docs/docs/.vitepress/config/shared.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { defineConfig } from 'vitepress'

export const shared = defineConfig({
base: '/SukiUI/',
title: "SukiUI",

themeConfig: {
logo: { src: '/suki.webp', width: 24, height: 24 },
socialLinks: [
{ icon: 'github', link: 'https://github.com/kikipoulet/SukiUI' }
]
}
})
124 changes: 124 additions & 0 deletions docs/docs/.vitepress/config/zh.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
import { defineConfig } from 'vitepress'

export const zh = defineConfig({
description: "一个 Avalonia 控件库",
themeConfig: {
nav: [
{ text: '主页', link: '/zh' },
{ text: '文档', link: '/zh/documentation' }
],

sidebar: [
{
text: '开始',
items: [
{ text: '介绍', link: '/zh/documentation/getting-started/introduction' },
{ text: '安装', link: '/zh/documentation/getting-started/installation' },
{ text: '启动', link: '/zh/documentation/getting-started/launch' },
]
},
{
text: '主题',
items: [
{ text: '主题实例', link: '/zh/documentation/theming/basic' },
{ text: '明暗主题切换', link: '/zh/documentation/theming/theme' },
{ text: '主题色', link: '/zh/documentation/theming/theme-color' },
]
},
{
text: '控件',
items: [
{
text: 'Navigation',
items: [
{ text: 'SideMenu', link: '/zh/documentation/controls/navigation/sidemenu' },
]
},
{
text: 'Layout',
items: [
{ text: 'GlassCard', link: '/zh/documentation/controls/layout/glasscard' },
{ text: 'TabControl', link: '/zh/documentation/controls/layout/tabcontrol' },
{ text: 'StackPage', link: '/zh/documentation/controls/layout/stackpage' },
{ text: 'SettingsLayout', link: '/zh/documentation/controls/layout/settingslayout' },
{ text: 'SukiWindow', link: '/zh/documentation/controls/layout/sukiwindow' },
]
},
{
text: 'Inputs',
items: [
{ text: 'Button', link: '/zh/documentation/controls/inputs/button' },
{ text: 'DropDownButton', link: '/zh/documentation/controls/inputs/dropdownbutton' },
{ text: 'ToggleSwitch', link: '/zh/documentation/controls/inputs/toggleswitch' },
{ text: 'ToggleButton', link: '/zh/documentation/controls/inputs/togglebutton' },
{ text: 'Slider', link: '/zh/documentation/controls/inputs/slider' },
{ text: 'ComboBox', link: '/zh/documentation/controls/inputs/combobox' },
{ text: 'NumericUpDown', link: '/zh/documentation/controls/inputs/numericupdown' },
{ text: 'TextBox', link: '/zh/documentation/controls/inputs/textbox' },
{ text: 'CheckBox', link: '/zh/documentation/controls/inputs/checkbox' },
{ text: 'RadioButton', link: '/zh/documentation/controls/inputs/radiobutton' },
{ text: 'ContextMenu', link: '/zh/documentation/controls/inputs/contextmenu' },
]
},
{
text: 'Text',
items: [
{ text: 'AutoCompleteBox', link: '/zh/documentation/controls/text/autocompletebox' },
{ text: 'TextBox', link: '/zh/documentation/controls/text/textbox' },
]
},
{
text: 'Date & Time',
items: [
{ text: 'Calendar', link: '/zh/documentation/controls/datetime/calendar' },
{ text: 'DatePicker', link: '/zh/documentation/controls/datetime/datepicker' },
]
},
{
text: 'Progress',
items: [
{ text: 'WaveProgress', link: '/zh/documentation/controls/progress/waveprogress' },
{ text: 'Stepper', link: '/zh/documentation/controls/progress/stepper' },
{ text: 'CircleProgressBar', link: '/zh/documentation/controls/progress/circleprogressbar' },
{ text: 'Loading', link: '/zh/documentation/controls/progress/loading' },
{ text: 'ProgressBar', link: '/zh/documentation/controls/progress/progressbar' },
]
},
{
text: 'Data Presentation',
items: [
{ text: 'DataGrid', link: '/zh/documentation/controls/data/datagrid' },
{ text: 'ListBox', link: '/zh/documentation/controls/data/listbox' },
{ text: 'TreeView', link: '/zh/documentation/controls/data/treeview' },
{ text: 'GroupBox', link: '/zh/documentation/controls/data/groupbox' },
{ text: 'BusyArea', link: '/zh/documentation/controls/data/busyarea' },
{ text: 'Expander', link: '/zh/documentation/controls/data/expander' },
]
},
{
text: 'System',
items: [
{ text: 'FilePicker', link: '/zh/documentation/controls/system/filepicker' },
]
}
]
},
{
text: '通知',
items: [
{ text: 'Dialog', link: '/zh/documentation/notification/dialog' },
{ text: 'Toast', link: '/zh/documentation/notification/toast' },
{ text: 'MessageBox', link: '/zh/documentation/notification/messagebox' },
]
},
{
text: '样式',
items: [
{ text: 'Text', link: '/zh/documentation/style/text' },
{ text: 'Color', link: '/zh/documentation/style/color' },
{ text: 'Icon', link: '/zh/documentation/style/icon' },
]
}
]
}
})
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
21 changes: 21 additions & 0 deletions docs/docs/documentation/getting-started/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Introduction

**SukiUI** makes your Avalonia applications more modern. The library offers a large number of animated controls and theme switches.

<div style="display: flex;justify-content: space-around;">
<img src="https://img.shields.io/github/stars/kikipoulet/SukiUI?style=for-the-badge"/>
<img src="https://img.shields.io/github/forks/kikipoulet/SukiUI?style=for-the-badge"/>
<img src="https://img.shields.io/github/commit-activity/m/kikipoulet/SukiUI
?style=for-the-badge"/>
<a href="https://www.nuget.org/packages/SukiUI"><img src="https://img.shields.io/nuget/vpre/SukiUI?style=for-the-badge" alt="Nuget Pre"/></a>
</div>

![dashboard](/getting-started/introduction-dashboard.webp)

## Gallery

Go to Microsoft Store to get the Gallary app

<a href="https://apps.microsoft.com/detail/9NM01BJ6JTTF?hl=en-us&gl=US">
<img src="https://get.microsoft.com/images/en-us%20dark.svg" width="200" alt="Download SukiUI Controls Gallery" />
</a>
Empty file.
1 change: 1 addition & 0 deletions docs/docs/documentation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# test
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
25 changes: 12 additions & 13 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
Expand All @@ -8,28 +7,28 @@ hero:
tagline: Modern, Simple, Animated
actions:
- theme: brand
text: Get Started
link: /markdown-examples
text: 🚀 Get Started
link: /documentation/getting-started/introduction
- theme: alt
text: Documentation
link: /api-examples
text: 📄 Documentation
link: /documentation
image:
src: https://raw.githubusercontent.com/kikipoulet/SukiUI/main/Images/OIG.N5o-removebg-preview.png
src: ./suki.webp
alt: SukiUILogo

features:
- title: Feature A
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature B
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: 🔧 Flexible Theme Customization
details: Support seamless switching themes and colors to align with your app's identity.
- title: 🎞️ Rich Animation
details: Captivate users with dynamic, fluid animations that make interactions delightful.
- title: 🖥️ Desktop Cross-platform
details: Based on AvaloniaUI, achieve broad compatibility with consistent performance on Windows, macOS, and Linux.
---

<style>
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #ede0b3 30%, #8f4136);
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #ede0b3 50%, #8f4136);
}

@media (min-width: 640px) {
Expand Down
Binary file not shown.
Binary file added docs/docs/public/suki.webp
Binary file not shown.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Loading

0 comments on commit 733a690

Please sign in to comment.