Merge pull request #296 from AuroraZiling/main

Docs Update
kikipoulet · Oct 5, 2024 · 4edb09b · 4edb09b
2 parents 16312d5 + 28a94c9
commit 4edb09b
Show file tree

Hide file tree

Showing 51 changed files with 641 additions and 210 deletions.
diff --git a/docs/docs/.vitepress/config/en.mts b/docs/docs/.vitepress/config/en.mts
@@ -115,6 +115,12 @@ export const en = defineConfig({
           { text: 'Toast', link: '/documentation/hosts/toast' },
         ]
       },
+      {
+        text: 'FAQ',
+        items: [
+          { text: 'Custom Font', link: '/documentation/faq/custom-font' },
+        ]
+      },
       {
         text: 'Style',
         items: [

diff --git a/docs/docs/.vitepress/config/shared.mts b/docs/docs/.vitepress/config/shared.mts
@@ -5,7 +5,7 @@ export const shared = defineConfig({
   title: "SukiUI",
 
   head: [
-    ['link', { rel: 'icon', type: 'image/webp', href: '/suki.webp' }],
+    ['link', { rel: 'icon', href: '/SukiUI/favicon.ico' }]
   ],
 
   themeConfig: {

diff --git a/docs/docs/.vitepress/config/zh.mts b/docs/docs/.vitepress/config/zh.mts
@@ -115,6 +115,12 @@ export const zh = defineConfig({
           { text: 'Toast', link: '/zh/documentation/hosts/toast' },
         ]
       },
+      {
+        text: 'FAQ',
+        items: [
+          { text: '自定义字体', link: '/zh/documentation/faq/custom-font' },
+        ]
+      },
       {
         text: '样式',
         items: [

diff --git a/docs/docs/documentation/controls/data/busyarea.md b/docs/docs/documentation/controls/data/busyarea.md
@@ -2,10 +2,8 @@
 
 ![busy](https://github.com/user-attachments/assets/1755b97b-9c67-4761-bc77-5884cc5314f3)
 
-
 ```xml
-      <suki:BusyArea BusyText="Busy..." IsBusy="{Binding IsBusy}"  >
-           ...
-      </suki:BusyArea>
-
-```
+<suki:BusyArea BusyText="Busy..." IsBusy="{Binding IsBusy}"  >
+      ...
+</suki:BusyArea>
+```
diff --git a/docs/docs/documentation/controls/data/groupbox.md b/docs/docs/documentation/controls/data/groupbox.md
@@ -1,14 +1,9 @@
-# GoupBox
-
-
-![{096A1DF6-55E9-4633-B472-6B403CF63080}](https://github.com/user-attachments/assets/ac5271d4-b0e2-4123-8aee-cc0f3cb6f0a0)
-
+# GroupBox
 
+![groupbox](https://github.com/user-attachments/assets/ac5271d4-b0e2-4123-8aee-cc0f3cb6f0a0)
 
 ```xml
-
 <suki:GroupBox Header="Title">
   ...
 </suki:GroupBox>
-
-```
+```
diff --git a/docs/docs/documentation/controls/data/listbox.md b/docs/docs/documentation/controls/data/listbox.md
@@ -1,3 +1,3 @@
 # Listbox
 
-![listbox](https://github.com/user-attachments/assets/9d250497-2b37-4b2f-b2e5-0d77c7340150)
+![listbox](https://github.com/user-attachments/assets/9d250497-2b37-4b2f-b2e5-0d77c7340150)
diff --git a/docs/docs/documentation/controls/data/treeview.md b/docs/docs/documentation/controls/data/treeview.md
@@ -1,3 +1,3 @@
 # Treeview
 
-![tree](https://github.com/user-attachments/assets/d076df54-00af-474b-8788-087de6305ff2)
+![tree](https://github.com/user-attachments/assets/d076df54-00af-474b-8788-087de6305ff2)
diff --git a/docs/docs/documentation/controls/inputs/button.md b/docs/docs/documentation/controls/inputs/button.md
@@ -2,75 +2,69 @@
 
 SukiUI has a handful of button styles, available in both the standard primary color, but also in the theme's accent color.
 
-<br/>
-
 ## Styles
 
 ### Standard
 
-<img src="https://sleekshot.app/api/download/wWleWLZYWqR6" />
+<img src="https://sleekshot.app/api/download/wWleWLZYWqR6" width="200px" />
 
 ```xml
 <Button Content="Button" ></Button>
 ```
 
 ### Flat
 
-<img src="https://sleekshot.app/api/download/tYN4eE9SLoot" />
+<img src="https://sleekshot.app/api/download/tYN4eE9SLoot" width="200px" />
 
 ```xml
 <Button Content="Button" Classes="Flat" ></Button>
 ```
 
 ### Rounded
 
-<img src="https://sleekshot.app/api/download/zKfpsqmZzaHV" />
+<img src="https://sleekshot.app/api/download/zKfpsqmZzaHV" width="200px" />
 
 ```xml
 <Button Content="Button" Classes="Flat Rounded" ></Button>
 ```
 
 ### Outlined
 
-<img src="https://sleekshot.app/api/download/uVA8CTxZ989L" />
+<img src="https://sleekshot.app/api/download/uVA8CTxZ989L" width="200px" />
 
 ```xml
 <Button Content="Button" Classes="Outlined" ></Button>
 ```
 
 ### Basic
 
-<img src="https://sleekshot.app/api/download/KTKtsjlVKsth" />
+<img src="https://sleekshot.app/api/download/KTKtsjlVKsth" width="200px" />
 
 ```xml
 <Button Content="Button" Classes="Basic" ></Button>
 ```
 
-
 ### Flat Accent
 
-<img src="https://sleekshot.app/api/download/vGFvTPZG1E8i" />
+<img src="https://sleekshot.app/api/download/vGFvTPZG1E8i" width="200px" />
 
 ```xml
 <Button Content="Button" Classes="Flat Accent" ></Button>
 ```
 
 ### Large
 
-<img src="https://sleekshot.app/api/download/LiWhO4edwZi3" />
+<img src="https://sleekshot.app/api/download/LiWhO4edwZi3" width="200px" />
 
 ```xml
 <Button Content="Button" Classes="Flat Large" ></Button>
 ```
 
-
-<br/>
-
 ## Busy/Loading Button
 
-<img src="/controls/inputs/button-busy.gif" height="300px" width="300px"/>
+<img src="/controls/inputs/button-busy.gif" width="300px"/>
 
-### Xaml
+### Axaml
 
 ```xml
 ...
@@ -88,7 +82,6 @@ xmlns:theme="clr-namespace:SukiUI.Theme;assembly=SukiUI"
    MyButton.HideProgress();
 ```
 
-
 ## See Also
 
 [Demo: SukiUI.Demo/Features/ControlsLibrary/ButtonsView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ButtonsView.axaml)
diff --git a/docs/docs/documentation/controls/inputs/numericupdown.md b/docs/docs/documentation/controls/inputs/numericupdown.md
@@ -2,11 +2,12 @@
 
 A control for numeric input.
 
+## Examples
+
 ### Simple
 
 <img src="https://sleekshot.app/api/download/nzfzrV8DgYEh"/>
 
-
 ```xml
 <NumericUpDown Value="10" />
 ```
@@ -15,7 +16,6 @@ A control for numeric input.
 
 <img src="https://sleekshot.app/api/download/qeEBVOXYPPC2"/>
 
-
 ```xml
 <NumericUpDown theme:NumericUpDownExtensions.Unit="inch" Value="10" />
 ```
@@ -24,13 +24,10 @@ A control for numeric input.
 
 <img src="https://sleekshot.app/api/download/4a9VFYrRaGb2"/>
 
-
 ```xml
 <NumericUpDown theme:NumericUpDownExtensions.Unit="inch" ShowButtonSpinner="False" Value="10" />
 ```
 
-
-
 ## See Also
 
 [Demo: SukiUI.Demo/Features/ControlsLibrary/MiscView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/MiscView.axaml)
diff --git a/docs/docs/documentation/controls/inputs/slider.md b/docs/docs/documentation/controls/inputs/slider.md
@@ -4,8 +4,7 @@ A control for displaying current value and intervals in range.
 
 ## Show
 
-![sliid](https://github.com/user-attachments/assets/80afe350-0032-41a8-b81c-5ff7acddf1e2)
-
+![slider](https://github.com/user-attachments/assets/80afe350-0032-41a8-b81c-5ff7acddf1e2)
 
 ## Example
 

diff --git a/docs/docs/documentation/controls/inputs/textbox.md b/docs/docs/documentation/controls/inputs/textbox.md
@@ -2,19 +2,19 @@
 
 A control used for collecting user provided information.
 
+## Examples
+
 ### Simple
 
 <img src="https://sleekshot.app/api/download/8nnHYLrgchCe"/>
 
-
 ```xml
 <TextBox Text="Hello" />
 ```
 
 ### Clear Button
 
-<img   src="https://sleekshot.app/api/download/tNkEf1yb0lml"/>
-
+<img src="https://sleekshot.app/api/download/tNkEf1yb0lml"/>
 
 ```xml
 <TextBox theme:TextBoxExtensions.AddDeleteButton="True"  Text="Hello" />
@@ -24,7 +24,6 @@ A control used for collecting user provided information.
 
 <img src="https://sleekshot.app/api/download/354ntrKtfvXo"/>
 
-
 ```xml
 <TextBox theme:TextBoxExtensions.Prefix="https://" Text="www.google.com" />
 ```
@@ -33,7 +32,6 @@ A control used for collecting user provided information.
 
 <img src="https://sleekshot.app/api/download/Y3odALgSfPCT"/>
 
-
 ```xml
 <TextBox Watermark="Watermark" Text="" />
 ```

diff --git a/docs/docs/documentation/controls/inputs/toggleswitch.md b/docs/docs/documentation/controls/inputs/toggleswitch.md
@@ -6,7 +6,6 @@ Switching between two states.
 
 ![tgs](https://github.com/user-attachments/assets/9fe52016-a002-4b4d-ad98-a3e2157a498c)
 
-
 ## Example
 
 ```xml
@@ -15,4 +14,4 @@ Switching between two states.
 
 ## See Also
 
-[Demo: SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml)
+[Demo: SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml)
diff --git a/docs/docs/documentation/controls/layout/dock.md b/docs/docs/documentation/controls/layout/dock.md
@@ -1,14 +1,10 @@
 # Dock
 
-
-
 As Docking controls are often asked by community, we decided to make a theme for the [Dock](https://github.com/wieslawsoltes/Dock) library. 
 
-
 ![dock](https://github.com/user-attachments/assets/ef7ec55f-f13c-4214-b5ce-ad5ef3042868)
 
-
-## Install SukiUI Nuget Package
+## Install SukiUI.Dock Nuget Package
 
 ![{F7E52AB9-7A5A-4007-9CBC-8258079C1F78}](https://github.com/user-attachments/assets/4fac741b-55da-41f8-90cf-bd47809f8e9f)
 
@@ -18,4 +14,4 @@ As Docking controls are often asked by community, we decided to make a theme for
 <StyleInclude Source="avares://SukiUI.Dock/Index.axaml" />
 ```
 
-You can now install and use the Dock library with SukiUI ! 
+You can now install and use the Dock library with SukiUI ! 
diff --git a/docs/docs/documentation/controls/layout/glasscard.md b/docs/docs/documentation/controls/layout/glasscard.md
@@ -2,6 +2,8 @@
 
 A simple Card control that can present any control inside.
 
+## Theme
+
 ### Dark Theme
 
 <img src="https://sleekshot.app/api/download/GfUS8bUZT6TQ"/>
@@ -10,21 +12,18 @@ A simple Card control that can present any control inside.
 
 <img src="https://sleekshot.app/api/download/M1xlZe6nmF72"/>
 
-
 ```xml
 <GlassCard>
     <!-- Content -->
 </GlassCard>
 ```
 
-
 ## Alternative Style
 
 ### Primary
 
 <img src="https://sleekshot.app/api/download/DC48QzG5R1XT"/>
 
-
 ```xml
 <GlassCard Classes="Primary">
     <!-- Content -->
@@ -35,7 +34,6 @@ A simple Card control that can present any control inside.
 
 <img src="https://sleekshot.app/api/download/cclRRlzglCB8"/>
 
-
 ```xml
 <GlassCard Classes="Accent">
     <!-- Content -->
@@ -46,7 +44,6 @@ A simple Card control that can present any control inside.
 
 <img src="https://sleekshot.app/api/download/MW4zpqNj9FLK"/>
 
-
 ```xml
 <GlassCard IsOpaque="True">
     <!-- Content -->
@@ -57,7 +54,6 @@ A simple Card control that can present any control inside.
 
 ![interactive](https://github.com/user-attachments/assets/0a1ba6ac-b3e0-4eb6-ad7e-f782820a0506)
 
-
 ```xml
 <GlassCard IsInteractive="True">
     <!-- Content -->
@@ -66,12 +62,10 @@ A simple Card control that can present any control inside.
 
 ## Animations
 
-GlassCard are animated with CompositionAnimations by the property IsAnimated set to 'True' by default. Opacity changes and Size changes of the GlassCard are automatically animated.
+`GlassCard` are animated with `CompositionAnimations` by the property `IsAnimated` set to `True` by default. `Opacity` changes and `Size` changes of the `GlassCard` are automatically animated.
 
 ![animated](https://github.com/user-attachments/assets/b38d4ec2-067a-443c-ac20-65a2f6302920)
 
-
-
 ## See Also
 
 [Demo: SukiUI.Demo/Features/ControlsLibrary/CardsView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/CardsView.axaml)
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,8 +4,7 @@ A control for displaying current value and intervals in range. @@
     ## Show
-    ![sliid](https://github.com/user-attachments/assets/80afe350-0032-41a8-b81c-5ff7acddf1e2)
+    ![slider](https://github.com/user-attachments/assets/80afe350-0032-41a8-b81c-5ff7acddf1e2)
     ## Example
@@ Expand Down @@