Skip to content

Commit d467788

Browse files
swyxioswyx
and
swyx
authored
reorg Advanced guides (typescript-cheatsheets#272)
Co-authored-by: swyx <[email protected]>
1 parent 417d163 commit d467788

25 files changed

+988
-880
lines changed

CONTRIBUTING.md

+36
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,39 @@ I thought I should lay out some core principles that we will follow so that this
1010
4. **Add TypeScript Playground Links**: Whenever adding a code example longer than four lines, add a link to the TypeScript Playground with the code. Use the default compiler Playground options.
1111

1212
That's all I've got! Again, really happy you are thinking about helping out, who knows, the person who you might be helping is yourself in future!
13+
14+
## Project structure
15+
16+
- All content is in `/docs`
17+
- the `/docs/basic` is compiled into `README.md` to preserve GitHub readability via GitHub action, thanks
18+
- `/website` consumes the `/docs` content, which is a [Docusaurus 2](https://docusaurus.io/) site, which also has [Algolia search](https://www.algolia.com/) (thanks to both teams for their support!)
19+
20+
The website is deployed to Netlify on swyx's personal account.
21+
22+
To run the docsite locally:
23+
24+
```bash
25+
yarn # install deps
26+
## make sure deps are installed in /website too
27+
cd website && yarn start
28+
```
29+
30+
example output from successful startup
31+
32+
```
33+
yarn run v1.22.4
34+
warning package.json: No license field
35+
$ docusaurus start
36+
Starting the development server...
37+
38+
✔ Client
39+
Compiled successfully in 9.61s
40+
41+
ℹ 「wds」: Project is running at http://localhost:3000/
42+
ℹ 「wds」: webpack output is served from /
43+
ℹ 「wds」: Content not from webpack is served from /Users/wanshawn/Work/react-typescript-cheatsheet/website
44+
ℹ 「wds」: 404s will fallback to /index.html
45+
46+
✔ Client
47+
Compiled successfully in 116.41ms
48+
```

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
<div align="center">
2727

28-
:wave: This repo is maintained by [@swyx](https://twitter.com/swyx), [@ferdaber](https://twitter.com/ferdaber), [@eps1lon](https://twitter.com/sebsilbermann), [@IslamAttrash](https://twitter.com/IslamAttrash), [@jsjoeio](https://twitter.com/jsjoeio) and [@arvindcheenu](https://twitter.com/arvincheenu), we're so happy you want to try out TypeScript with React! If you see anything wrong or missing, please [file an issue](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet/issues/new/choose)! :+1:
28+
:wave: This repo is maintained by [@swyx](https://twitter.com/swyx), [@ferdaber](https://twitter.com/ferdaber), [@eps1lon](https://twitter.com/sebsilbermann), [@jsjoeio](https://twitter.com/jsjoeio) and [@arvindcheenu](https://twitter.com/arvincheenu), we're so happy you want to try out TypeScript with React! If you see anything wrong or missing, please [file an issue](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet/issues/new/choose)! :+1:
2929

3030
</div>
3131

docs/advanced/guides/conditionally-rendering.md

-54
This file was deleted.

docs/advanced/guides/extract-props.md

-47
This file was deleted.

docs/advanced/guides/generic-components.md

-203
This file was deleted.

0 commit comments

Comments
 (0)