Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website: Update getting started documentation & demos #1358

Merged
merged 2 commits into from
Jun 23, 2023
Merged

website: Update getting started documentation & demos #1358

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70f71d5
Initial push.
FlyersPh9 Jun 15, 2023
e7d83a4
Merge branch 'dev' into jon/documentation-site-getting-started
FlyersPh9 Jun 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions apps/website/src/pages/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ layout: ./_layout.astro
toc: false
---

## Installation
## For developers

### Installation

```shell
npm install @itwin/itwinui-react
Expand All @@ -15,7 +17,7 @@ npm install @itwin/itwinui-react
yarn add @itwin/itwinui-react
```

## Setup
### Setup

Wrap your application entrypoint in `ThemeProvider` and import `styles.css`.

Expand All @@ -39,7 +41,7 @@ ThemeProvider has a `theme` prop which accepts one of the following values:
- `os` (respects the color scheme of the operating system)
- `inherit`

## Usage
### Usage

After setting up ThemeProvider and styles, import the component you want and start using it!

Expand All @@ -52,3 +54,16 @@ const Page = () => <Button>Hello!</Button>;
Check out this template for a live interactive demo:

[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/s/github/iTwin/iTwinUI/tree/main/cra-sandbox?file=/src/App.tsx)

## For designers

### UI kit

Download the iTwinUI design kits and start creating experiences. These UI kits are available via [the iTwinUI Figma Community page](https://www.figma.com/@itwinui).

### Fonts

iTwinUI uses the Noto Sans font family, created in collaboration by Adobe and Google. We suggest these two methods of downloading the font family:

- If you use Adobe Creative Cloud, you can sync the fonts using [Adobe Fonts](https://fonts.adobe.com/fonts/noto-sans).
- If you do not use Adobe Creative Cloud, you can download the files from [Google Fonts](https://fonts.google.com/noto/specimen/Noto+Sans).