Skip to content

Commit 522cdf9

Browse files
committed
update docs font style, remove link to wiki and update markdown pages
1 parent 25a93d3 commit 522cdf9

File tree

9 files changed

+40
-23
lines changed

9 files changed

+40
-23
lines changed

markdowns/foundation/assets.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ index: 6
33
path: "/foundation/assets"
44
title: "Assets"
55
---
6-
Assets are big part of the whole UI system, whether it's an icon, placeholder or an illustration, we use them everywhere. <br>
6+
Assets are big part of the whole UI system, whether it's an icon, placeholder or an illustration, we use them everywhere.
77
Load assets groups and easily render them with the _Image_ component.
88

9-
```jsx
9+
```javascript
1010
import {Assets, Image} from 'react-native-ui-lib';
1111

1212
Assets.loadAssetsGroup('icons', {
@@ -25,6 +25,10 @@ Assets.loadAssetsGroup('illustrations.emptyStates.', {
2525
noContacts: require('noContacts.png'),
2626
});
2727

28+
```
29+
30+
And use them like this
31+
```jsx
2832
// Use them with the Image component (our Image component)
2933
<Image assetName="icon1"/> // default assetGroup is "icons"
3034
<Image assetName="emptyCart" assetGroup="illustrations.placeholders"/>

markdowns/foundation/modifiers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ index: 5
33
path: "/foundation/modifiers"
44
title: "Modifiers"
55
---
6-
As you probably noticed already, we translate our style presets into modifiers.
6+
As you probably noticed already, we translate our style presets into modifiers.
77
**Modifiers** will help you create a stunning UI easily and quickly.
88

99
**[!IMPORTANT]** <br>

markdowns/foundation/style.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: "Style"
66
The base foundation of each UI component is its style.
77
We use basic style presets to define the rules and the style guide we follow.
88

9-
Our presets includes: **Colors**, **Typography**, **Shadows**, **Border Radius** and more..
9+
Our presets includes: **Colors**, **Typography**, **Spacings**, **Shadows**, **Border Radius** and more..
1010

1111
The UILib already comes with a set of predefined constants and [presets](https://github.com/wix/react-native-ui-lib/tree/master/src/style).
1212

@@ -15,7 +15,7 @@ You can easily use it anywhere in your code as you would have used any other con
1515
It's also very easy to define your own presets..
1616

1717
```jsx
18-
import {Typography, Colors} from 'react-native-ui-lib';
18+
import {Typography, Colors, Spacings} from 'react-native-ui-lib';
1919

2020
Colors.loadColors({
2121
pink: '#FF69B4',
@@ -26,6 +26,10 @@ Typography.loadTypographies({
2626
h1: {fontSize: 58, fontWeight: '300', lineHeight: 80},
2727
h2: {fontSize: 46, fontWeight: '300', lineHeight: 64},
2828
});
29+
30+
Spacings.loadSpacings({
31+
page: isSmallScreen ? 16 : 20
32+
});
2933
```
3034

3135
and so for example, the following line

markdowns/foundation/theme-manager.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ ThemeManager.setComponentTheme('Text', {
2626
ThemeManager.setComponentTheme('Button', (props, context) => {
2727
2828
return {
29-
backgroundColor: props.outline ? 'black' : 'green' , // this will apply a different backgroundColor depends if the Button is an outline or not
29+
// this will apply a different backgroundColor
30+
// depends if the Button is an outline or not
31+
backgroundColor: props.outline ? 'black' : 'green',
3032
};
3133
});
3234
```

markdowns/getting-started/setup.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ title: "Setup"
88
Before you start.
99
Starting version 5.12.0 UILib exports individual packages so you can import only what you need.
1010

11-
**Why packages are important?**
11+
### Why packages are important?
1212
- Smaller bundle size. By importing only the components you need, your bundle size will be reduced to the files that were imported.
1313
- Quicker setup. Avoid installing peer dependencies and linking native depdencies that you don't need.
1414

15-
**How does it work?**
16-
```
15+
### How does it work?
16+
```javascript
1717
import View from 'react-native-ui-lib/view';
1818
import Text from 'react-native-ui-lib/text';
1919
import {KeyboardTrackingView, KeyboardAwareInsetsView, KeyboardRegistry, KeyboardAccessoryView, KeyboardUtils} from 'react-native-ui-lib/keyboard';
@@ -26,7 +26,7 @@ import {KeyboardTrackingView, KeyboardAwareInsetsView, KeyboardRegistry, Keyboar
2626
First, run `npm install react-native-ui-lib`
2727

2828
### Peer Dependencies
29-
:information_source: If you're planning on using speicific components, see **UILib Packages**.
29+
If you're planning on using specific components, see **UILib Packages**.
3030
*For some packages you might still need to install one of the peer dependencies*
3131

3232
If you want it all, install **peer dependencies**
@@ -38,7 +38,7 @@ cd ios && pod install
3838

3939

4040
## Install Native Dependencies (must)
41-
:information_source: If you're planning on using speicific components, see **UILib Packages**.
41+
If you're planning on using speicific components, see **UILib Packages**.
4242
*For some packages you might still need to install one of the native dependencies*
4343

4444
Some of the components are using these native dependencies, they are defined as peer dependencies so you can install the version that suit you.
@@ -54,11 +54,10 @@ It's important to run `cd ios && pod install` if you are using a component that
5454

5555
## Demo App
5656

57-
Our demo app is located [here](https://github.com/wix/react-native-ui-lib/tree/master/demo).
58-
59-
To run it:
57+
Our demo app is located [here](https://github.com/wix/react-native-ui-lib/tree/master/demo). To run it:
6058

61-
- install dependencies: `npm install`
59+
- Clone the repo
60+
- Install dependencies: `npm install`
6261
- (for iOS) `cd ios && pod install && cd ..`
63-
- start the packager: `npm start`
64-
- run: `npm run ios` or `npm run android` (or within Xcode or Android Studio)
62+
- Start the packager: `npm start`
63+
- Build the app: `npm run ios` or `npm run android` (or from Xcode or Android Studio)

uilib-docs/src/components/header.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ const Header = () => {
1818
<a target="_blank" href="https://github.com/wix/react-native-ui-lib">
1919
GitHub
2020
</a>
21-
<a target="_blank" href="https://github.com/wix/react-native-ui-lib/wiki">
22-
Uncyclo
23-
</a>
2421
</div>
2522
</div>
2623
);

uilib-docs/src/styles/components.scss

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
h1 {
2-
font-weight: 400;
2+
font-weight: 500;
33
}
44

55
h2 {
66
font-weight: 500;
77
}
88

99
h3 {
10-
font-weight: 500;
10+
font-weight: 600;
1111
}
1212

1313
h4 {
@@ -21,3 +21,7 @@ h5 {
2121
p {
2222
font-size: $text30;
2323
}
24+
25+
strong {
26+
font-weight: 600;
27+
}

uilib-docs/src/styles/global.scss

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
@import url('https://fonts.googleapis.com/css?family=Montserrat:100,200,300,400,500,600,700,800,900&display=swap');
2+
@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@100;200;300;400;500;600;700;800;900&display=swap');
23
@import "src/styles/constants";
34
@import "src/styles/components";
45

@@ -7,7 +8,8 @@ body {
78
width: 100%;
89
height: 100%;
910
margin: 0;
10-
font-family: Montserrat, Geneva, sans-serif;
11+
// font-family: Montserrat, Geneva, sans-serif;
12+
font-family: Poppins, sans-serif;
1113
-webkit-font-smoothing: antialiased;
1214
}
1315

uilib-docs/src/templates/markdown.scss

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,25 @@
2121
border-radius: 4px;
2222
padding: 16px;
2323
max-width: 60vw;
24+
box-shadow: 2px 2px 2px $dark60;
2425

2526
code {
2627
background: transparent;
2728
color: $dark10;
29+
padding: 0;
2830
}
2931
}
3032

3133
code {
3234
font-size: 16px;
35+
line-height: 1.3;
3336
display: inline;
3437
word-break: break-word;
3538
width: 100%;
3639
background: $dark70;
3740
color: $primary;
41+
padding: 6px 10px;
42+
border-radius: 4px;
3843
}
3944

4045
li {

0 commit comments

Comments
 (0)