Skip to content
This repository was archived by the owner on Nov 3, 2025. It is now read-only.

Commit 5009c4a

Browse files
committed
📝 (docz) correct mistakes
1 parent 0f33924 commit 5009c4a

5 files changed

Lines changed: 34 additions & 6 deletions

File tree

docs/GettingStarted.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,24 @@ const SignInCanal = createCanal([
3939
]);
4040
```
4141

42-
Then, use the canal wherever you want in your app. Specify wether to show/hide a screen by using the screen's name as a prop:
42+
Then, use the canal wherever you want in your app. Specify whether to show/hide a screen by using the screen's name as a prop:
4343

4444
```ts
4545
import React, { Component } from "react";
4646
import { SignInCanal } from "./canals/SignIn";
4747

4848
export default class App extends Component {
4949
render() {
50-
return <SignInCanal firstName />;
50+
return <SignInCanal firstName={true} lastName={false} />;
5151
}
5252
}
5353
```
5454

5555
That's all !
5656

57-
### Add some full screen page
57+
### Add a full screen page
5858

59-
If you want to add full screen page, pass the `isFullScreen` flag when creating a canal. In the following example, `confirm` is a full screen page.
59+
If you want to add full screen page, pass the `isFullScreen` flag to the right page when creating a canal. In the following example, `confirm` is a full screen page.
6060

6161
```ts
6262
import React from "react";
@@ -89,4 +89,4 @@ export default class App extends Component {
8989
}
9090
```
9191

92-
You are ready to use React-Gondola
92+
You are ready to use React-Gondola 🎸.

docs/Roadmap.mdx

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,22 @@ name: Roadmap
66

77
If there is a real interest on `react-gondola` and its phylosophy, I might add support for the following features:
88

9+
- go back event listener
910
- transitions
1011
- navigation gestures
1112

12-
Tweet me some encouragements 😁
13+
Tweet me some encouragements 😁 and star the repo !
14+
15+
import GitHubButton from "react-github-btn";
16+
17+
<GitHubButton
18+
href="https://github.com/tpucci/react-gondola"
19+
data-icon="octicon-star"
20+
data-size="large"
21+
data-show-count="true"
22+
aria-label="Star tpucci/react-gondola on GitHub"
23+
>
24+
Star
25+
</GitHubButton>
1326

1427
My twitter: [@Thomas_Pucci](https://twitter.com/Thomas_Pucci)

docs/Welcome.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
name: Welcome
3+
route: /
34
---
45

56
# React Gondola

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
"scripts": {
2323
"predoc:build": "cd example && yarn && cd ..",
2424
"doc:build": "docz build",
25+
"doc:dev": "docz dev",
2526
"release": "release-it",
2627
"test:ci": "yarn test:lint && yarn test:unit:ci && yarn test:type",
2728
"test:lint": "tslint src/**/*.ts{,x}",
@@ -52,6 +53,7 @@
5253
"prettier": "^1.16.4",
5354
"react": "16.8.6",
5455
"react-dom": "16.8.6",
56+
"react-github-btn": "^1.0.5",
5557
"react-native": "0.59.5",
5658
"react-native-web": "^0.11.4",
5759
"react-test-renderer": "^16.8.6",

yarn.lock

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5984,6 +5984,11 @@ gitconfiglocal@^1.0.0:
59845984
dependencies:
59855985
ini "^1.3.2"
59865986

5987+
github-buttons@^2.2.9:
5988+
version "2.2.9"
5989+
resolved "https://registry.yarnpkg.com/github-buttons/-/github-buttons-2.2.9.tgz#fb426fa469a2050a1c5d69b6413da0d1537f235b"
5990+
integrity sha512-G/UGx6GKUL3747gTUULGGqWDjKANVbLCnCHdYMqf1iUGYxIj+wMHK9WG4e4J/V0bG03auI4o6bZJQf7IjHyE1A==
5991+
59875992
github-slugger@^1.0.0, github-slugger@^1.1.1:
59885993
version "1.2.1"
59895994
resolved "https://registry.yarnpkg.com/github-slugger/-/github-slugger-1.2.1.tgz#47e904e70bf2dccd0014748142d31126cfd49508"
@@ -10440,6 +10445,13 @@ react-feather@^1.1.6:
1044010445
resolved "https://registry.yarnpkg.com/react-feather/-/react-feather-1.1.6.tgz#2a547e3d5cd5e383d3da0128d593cbdb3c1b32f7"
1044110446
integrity sha512-iCofWhTjX+vQwvDmg7o6vg0XrUg1c41yBDZG+l83nz1FiCsleJoUgd3O+kHpOeWMXuPrRIFfCixvcqyOLGOgIg==
1044210447

10448+
react-github-btn@^1.0.5:
10449+
version "1.0.5"
10450+
resolved "https://registry.yarnpkg.com/react-github-btn/-/react-github-btn-1.0.5.tgz#03ee7c6cd51f04ef940543b5ec247fbe4fe09a05"
10451+
integrity sha512-wE3s2e3Rrs6I9n2TDdBSUzTQXJy68EetFBxrYPosAVp/OSP5DwI9u/npf/Eu0/Uww1pTh60yvYO2wOS63HihkQ==
10452+
dependencies:
10453+
github-buttons "^2.2.9"
10454+
1044310455
react-hot-loader@^4.8.4:
1044410456
version "4.8.8"
1044510457
resolved "https://registry.yarnpkg.com/react-hot-loader/-/react-hot-loader-4.8.8.tgz#71e3c7ba301556aa24c52cef2f6ed0af82395eea"

0 commit comments

Comments
 (0)