Skip to content

Commit 6007d3c

Browse files
docs: update to include cra template usage (#137)
* components: adding cra option in try component * docs: auto updating starter docs
1 parent 84cbb14 commit 6007d3c

File tree

6 files changed

+52
-12
lines changed

6 files changed

+52
-12
lines changed

website/docs/api/globals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: "globals"
3-
title: "@nodegui/react-nodegui"
3+
title: "@nodegui/react-nodegui - v0.4.0"
44
sidebar_label: "Globals"
55
---
66

website/docs/api/index.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: "index"
3-
title: "@nodegui/react-nodegui"
3+
title: "@nodegui/react-nodegui - v0.4.0"
44
sidebar_label: "README"
55
---
66

@@ -114,19 +114,25 @@ People maintaining this project.
114114
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
115115

116116
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
117-
<!-- prettier-ignore -->
117+
<!-- prettier-ignore-start -->
118+
<!-- markdownlint-disable -->
118119
<table>
119120
<tr>
120-
<td align="center"><a href="http://rahulgaba.com"><img src="https://avatars3.githubusercontent.com/u/7898942?v=4" width="100px;" alt="Rahul Gaba"/><br /><sub><b>Rahul Gaba</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=rgabs" title="Code">💻</a></td>
121-
<td align="center"><a href="https://github.com/kakulgupta"><img src="https://avatars3.githubusercontent.com/u/10727047?v=4" width="100px;" alt="Kakul Gupta"/><br /><sub><b>Kakul Gupta</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=kakulgupta" title="Code">💻</a></td>
122-
<td align="center"><a href="https://github.com/Nicify"><img src="https://avatars3.githubusercontent.com/u/24217275?v=4" width="100px;" alt="Eva1ent"/><br /><sub><b>Eva1ent</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=Nicify" title="Code">💻</a></td>
123-
<td align="center"><a href="https://github.com/slidinghotdog"><img src="https://avatars3.githubusercontent.com/u/33790211?v=4" width="100px;" alt="slidinghotdog"/><br /><sub><b>slidinghotdog</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=slidinghotdog" title="Code">💻</a></td>
124-
<td align="center"><a href="https://www.linkedin.com/in/roysommer/"><img src="https://avatars2.githubusercontent.com/u/6681893?v=4" width="100px;" alt="Roy Sommer"/><br /><sub><b>Roy Sommer</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=illBeRoy" title="Code">💻</a></td>
125-
<td align="center"><a href="https://github.com/nateshmbhat"><img src="https://avatars1.githubusercontent.com/u/23279926?v=4" width="100px;" alt="Natesh M Bhat"/><br /><sub><b>Natesh M Bhat</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=nateshmbhat" title="Documentation">📖</a></td>
126-
<td align="center"><a href="https://www.greatapes.fi"><img src="https://avatars3.githubusercontent.com/u/3404389?v=4" width="100px;" alt="Mikko Sairio"/><br /><sub><b>Mikko Sairio</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=msairio" title="Code">💻</a></td>
121+
<td align="center"><a href="http://rahulgaba.com"><img src="https://avatars3.githubusercontent.com/u/7898942?v=4" width="100px;" alt=""/><br /><sub><b>Rahul Gaba</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=rgabs" title="Code">💻</a></td>
122+
<td align="center"><a href="https://github.com/kakulgupta"><img src="https://avatars3.githubusercontent.com/u/10727047?v=4" width="100px;" alt=""/><br /><sub><b>Kakul Gupta</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=kakulgupta" title="Code">💻</a></td>
123+
<td align="center"><a href="https://github.com/Nicify"><img src="https://avatars3.githubusercontent.com/u/24217275?v=4" width="100px;" alt=""/><br /><sub><b>Eva1ent</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=Nicify" title="Code">💻</a></td>
124+
<td align="center"><a href="https://github.com/slidinghotdog"><img src="https://avatars3.githubusercontent.com/u/33790211?v=4" width="100px;" alt=""/><br /><sub><b>slidinghotdog</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=slidinghotdog" title="Code">💻</a></td>
125+
<td align="center"><a href="https://www.linkedin.com/in/roysommer/"><img src="https://avatars2.githubusercontent.com/u/6681893?v=4" width="100px;" alt=""/><br /><sub><b>Roy Sommer</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=illBeRoy" title="Code">💻</a></td>
126+
<td align="center"><a href="https://github.com/nateshmbhat"><img src="https://avatars1.githubusercontent.com/u/23279926?v=4" width="100px;" alt=""/><br /><sub><b>Natesh M Bhat</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=nateshmbhat" title="Documentation">📖</a></td>
127+
<td align="center"><a href="https://www.greatapes.fi"><img src="https://avatars3.githubusercontent.com/u/3404389?v=4" width="100px;" alt=""/><br /><sub><b>Mikko Sairio</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=msairio" title="Code">💻</a></td>
128+
</tr>
129+
<tr>
130+
<td align="center"><a href="https://github.com/shubhamzanwar"><img src="https://avatars0.githubusercontent.com/u/15626155?v=4" width="100px;" alt=""/><br /><sub><b>Shubham Zanwar</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=shubhamzanwar" title="Code">💻</a></td>
127131
</tr>
128132
</table>
129133

134+
<!-- markdownlint-enable -->
135+
<!-- prettier-ignore-end -->
130136
<!-- ALL-CONTRIBUTORS-LIST:END -->
131137

132138
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

website/docs/api/interfaces/animatedimageprops.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ sidebar_label: "AnimatedImageProps"
2525
* [minSize](animatedimageprops.md#optional-minsize)
2626
* [mouseTracking](animatedimageprops.md#optional-mousetracking)
2727
* [on](animatedimageprops.md#optional-on)
28+
* [openExternalLinks](animatedimageprops.md#optional-openexternallinks)
2829
* [pos](animatedimageprops.md#optional-pos)
2930
* [ref](animatedimageprops.md#optional-ref)
3031
* [scaledContents](animatedimageprops.md#optional-scaledcontents)
@@ -147,6 +148,14 @@ Prop to set the event listener map. See [Handlong Events](/docs/guides/handle-ev
147148

148149
___
149150

151+
### `Optional` openExternalLinks
152+
153+
**openExternalLinks**? : *undefined | false | true*
154+
155+
*Inherited from [TextProps](textprops.md).[openExternalLinks](textprops.md#optional-openexternallinks)*
156+
157+
___
158+
150159
### `Optional` pos
151160

152161
**pos**? : *Position*

website/docs/api/interfaces/imageprops.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ sidebar_label: "ImageProps"
2626
* [minSize](imageprops.md#optional-minsize)
2727
* [mouseTracking](imageprops.md#optional-mousetracking)
2828
* [on](imageprops.md#optional-on)
29+
* [openExternalLinks](imageprops.md#optional-openexternallinks)
2930
* [pos](imageprops.md#optional-pos)
3031
* [ref](imageprops.md#optional-ref)
3132
* [scaledContents](imageprops.md#optional-scaledcontents)
@@ -155,6 +156,14 @@ Prop to set the event listener map. See [Handlong Events](/docs/guides/handle-ev
155156

156157
___
157158

159+
### `Optional` openExternalLinks
160+
161+
**openExternalLinks**? : *undefined | false | true*
162+
163+
*Inherited from [TextProps](textprops.md).[openExternalLinks](textprops.md#optional-openexternallinks)*
164+
165+
___
166+
158167
### `Optional` pos
159168

160169
**pos**? : *Position*

website/docs/api/interfaces/textprops.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ sidebar_label: "TextProps"
2828
* [minSize](textprops.md#optional-minsize)
2929
* [mouseTracking](textprops.md#optional-mousetracking)
3030
* [on](textprops.md#optional-on)
31+
* [openExternalLinks](textprops.md#optional-openexternallinks)
3132
* [pos](textprops.md#optional-pos)
3233
* [ref](textprops.md#optional-ref)
3334
* [scaledContents](textprops.md#optional-scaledcontents)
@@ -141,6 +142,12 @@ Prop to set the event listener map. See [Handlong Events](/docs/guides/handle-ev
141142

142143
___
143144

145+
### `Optional` openExternalLinks
146+
147+
**openExternalLinks**? : *undefined | false | true*
148+
149+
___
150+
144151
### `Optional` pos
145152

146153
**pos**? : *Position*

website/src/components/Try.js

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,16 @@ export const Try = () => {
5252
<Center>
5353
<H2>Give it a try</H2>
5454
<Description>
55-
<SubTitle>1. Run these commands</SubTitle>
55+
<SubTitle>1. Use the CRA template</SubTitle>
56+
<Terminal>
57+
<Code>
58+
create-react-app --template react-nodegui rn-starter
59+
</Code>
60+
<Code>cd rn-starter</Code>
61+
<Code>npm run dev</Code>
62+
<Code>npm start</Code>
63+
</Terminal>
64+
<SubTitle>2. Run these commands</SubTitle>
5665
<Terminal>
5766
<Code>
5867
git clone https://github.com/nodegui/react-nodegui-starter
@@ -63,7 +72,7 @@ export const Try = () => {
6372
<Code>npm start</Code>
6473
</Terminal>
6574
<SubTitle>
66-
2.{" "}
75+
3.{" "}
6776
<a className="LinkBasics" href={"docs/guides/getting-started"}>
6877
Learn the basics
6978
</a>{" "}

0 commit comments

Comments
 (0)