From 1a038f0522e047e6f6ff60e73c6a0c05780907c3 Mon Sep 17 00:00:00 2001 From: Lachlan Campbell Date: Wed, 10 Apr 2024 01:34:55 -0400 Subject: [PATCH 1/3] Fix typos in README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 92d4c9a2..5980e6c3 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Build performant 3D user interfaces for **Three.js** using **@react-three/fiber* npm install three @react-three/fiber @react-three/uikit ``` -### What does it look like ? +### What does it look like? | A simple UI with 2 containers horizontally aligned, rendered in fullscreen. When the user hovers over a container, the container's opacity changes. | ![render of the above code](./docs/getting-started/basic-example.gif) | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | @@ -56,10 +56,10 @@ We provide multiple kits containing **themable pre-styled components**. Inspired Get started with **[building your first layout](https://docs.pmnd.rs/uikit/getting-started/first-layout)**, take a look at our **[examples](https://docs.pmnd.rs/uikit/getting-started/examples)** to see uikit in action, or learn more about: - [All components and their properties](https://docs.pmnd.rs/uikit/getting-started/components-and-properties) -- [Interacitivity](https://docs.pmnd.rs/uikit/tutorials/interactivity) +- [Interactivity](https://docs.pmnd.rs/uikit/tutorials/interactivity) - [Custom materials](https://docs.pmnd.rs/uikit/tutorials/custom-materials) - [Custom fonts](https://docs.pmnd.rs/uikit/tutorials/custom-fonts) -- [Responsivene user interfaces](https://docs.pmnd.rs/uikit/tutorials/responsive) +- [Responsive user interfaces](https://docs.pmnd.rs/uikit/tutorials/responsive) - [Scrolling](https://docs.pmnd.rs/uikit/tutorials/scroll) - [Sizing](https://docs.pmnd.rs/uikit/tutorials/sizing) - [Common pitfalls](https://docs.pmnd.rs/uikit/advanced/pitfalls) From 2c0e98079b22630c8dc561aabd65c95da2dc8240 Mon Sep 17 00:00:00 2001 From: Lachlan Campbell Date: Wed, 10 Apr 2024 13:25:08 -0400 Subject: [PATCH 2/3] Apply updates to website docs --- docs/getting-started/introduction.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md index a72443e1..d6e0eb20 100644 --- a/docs/getting-started/introduction.md +++ b/docs/getting-started/introduction.md @@ -14,7 +14,7 @@ Build performant 3D user interfaces for **Three.js** using **@react-three/fiber* npm install three @react-three/fiber @react-three/uikit ``` -### What does it look like ? +### What does it look like? | A simple UI with 2 containers horizontally aligned, rendered in fullscreen. When the user hovers over a container, the container's opacity changes. | ![render of the above code](./basic-example.gif) | | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | @@ -35,7 +35,7 @@ createRoot(document.getElementById('root')).render( ) ``` -## Pre-Styled Component Kits +## Pre-styled component kits We provide multiple kits containing **themable pre-styled components**. Inspired by shadcn, you can use our CLI to install the source code of any component to your desired loaction with one command. > For example, to add the button from the default kit, run: `npx uikit component add default Button` @@ -46,7 +46,7 @@ We provide multiple kits containing **themable pre-styled components**. Inspired | [View All Components](../kits/default.md) | [View All Components](../kits/apfel.md) | | `npx uikit component add default Button` | `npx uikit component add apfel Button` | -## How to get started? +## How to get started > Some familiarity with react, threejs, and @react-three/fiber, is recommended. @@ -54,18 +54,18 @@ react, threejs, and @react-three/fiber, is recommended. Get started with **[building your first layout](./first-layout.md)**, take a look at our **[examples](./examples.md)** to see uikit in action, or learn more about: - [All components and their properties](./components-and-properties.md) -- [Interacitivity](../tutorials/interactivity.md) +- [Interactivity](../tutorials/interactivity.md) - [Custom materials](../tutorials/custom-materials.md) - [Custom fonts](../tutorials/custom-fonts.md) -- [Responsivene user interfaces](../tutorials/responsive.md) +- [Responsive user interfaces](../tutorials/responsive.md) - [Scrolling](../tutorials/scroll.md) - [Sizing](../tutorials/sizing.md) - [Common pitfalls](../advanced/pitfalls.md) - [Optimize performance](../advanced/performance.md) - [Theming components](../kits/theming.md) -## Migration Guides +## Migration guides - from [Koestlich](../migration/from-koestlich.md) - from [HTML/CSS](../migration/from-html-css.md) -- from [Tailwind](../migration/from-tailwind.md) \ No newline at end of file +- from [Tailwind](../migration/from-tailwind.md) From d99a1645731fb75a7715a284fd24105aae2d41b6 Mon Sep 17 00:00:00 2001 From: Lachlan Campbell Date: Wed, 10 Apr 2024 14:25:45 -0400 Subject: [PATCH 3/3] Fix capitalization on README too --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5980e6c3..6199e7dd 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ createRoot(document.getElementById('root')).render( ) ``` -## Pre-Styled Component Kits +## Pre-styled component kits We provide multiple kits containing **themable pre-styled components**. Inspired by shadcn, you can use our CLI to install the source code of any component to your desired loaction with one command. @@ -48,7 +48,7 @@ We provide multiple kits containing **themable pre-styled components**. Inspired | [View All Components](https://docs.pmnd.rs/uikit/kits/default) | [View All Components](https://docs.pmnd.rs/uikit/kits/apfel) | | `npx uikit component add default Button` | `npx uikit component add apfel Button` | -## How to get started? +## How to get started > Some familiarity with > react, threejs, and @react-three/fiber, is recommended. @@ -66,7 +66,7 @@ Get started with **[building your first layout](https://docs.pmnd.rs/uikit/getti - [Optimize performance](https://docs.pmnd.rs/uikit/advanced/performance) - [Theming components](https://docs.pmnd.rs/uikit/kits/theming) -## Migration Guides +## Migration guides - from [Koestlich](https://docs.pmnd.rs/uikit/migration/from-koestlich) - from [HTML/CSS](https://docs.pmnd.rs/uikit/migration/from-html-css)