DEV Community 👩‍💻👨‍💻

Cover image for Let's Build React and TypeScript Documentation Together
Aryan J
Aryan J

Posted on

Let's Build React and TypeScript Documentation Together

GitHub logo AryanJ-NYC / reactandtypescript.dev

Documentation for using TypeScript with React. Written using docz.

React and TypeScript

Description

I created React And TypeScript as a way for me to learn React and TypeScript. I decided to share my notes online which is exactly what you're looking at here. I hope for this project to grow and be THE default source for React and TypeScript documentation.

Run Locally

In your terminal at the project root, run:

  1. yarn
  2. yarn start

Contributing

Thank you for your interest in contributing to the React And TypeScript unoffical documentation. Please visit the Contributing page to learn more about contributing to this project.




How It Started

It seemed as if every time I tried to start a React project using TypeScript, I'd take way too much time on getting the TypeScript right. I started my unofficial React and TypeScript documentation as a way to keep my own notes on using TypeScript with React (and as a way to play with Gatsby and docz).

Inspiration

The idea and a lot of the material is admittedly heavily based off @swyx's TypeScript Cheatsheet. I believe a website can add more functionality (search, for instance) than a standard GitHub README.

Prerequisites to Contributing

I do not foresee contributing to the project to be exceptionally difficult. However, some React and Markdown experience is required:

  1. A contributor will need React experience to validate that the documentation they submit to the repository.
  2. A contributor will need Markdown experience to actually write the documentation (the entire repository is basically a bunch of mdx files)

Hopes for This Project

I hope React and TypeScript becomes the de facto place for users to find React and TypeScript documentation. Additionally, I hope this provides a safe place for beginners to submit pull requests and learn how to use TypeScript with React by actually writing the documentation.

Ways to Help

The greatest help will come from an active GitHub community full of new ideas (issues) and contributors. However, I understand that that may not be possible for some people. It's all good though! Show me some love by sharing this article, sharing the GitHub repo or even just clicking "Star" on the GitHub repo.

GitHub logo AryanJ-NYC / reactandtypescript.dev

Documentation for using TypeScript with React. Written using docz.

React and TypeScript

Description

I created React And TypeScript as a way for me to learn React and TypeScript. I decided to share my notes online which is exactly what you're looking at here. I hope for this project to grow and be THE default source for React and TypeScript documentation.

Run Locally

In your terminal at the project root, run:

  1. yarn
  2. yarn start

Contributing

Thank you for your interest in contributing to the React And TypeScript unoffical documentation. Please visit the Contributing page to learn more about contributing to this project.




Top comments (1)

Collapse
rnrnshn profile image
Olimpio

I don't have react experience but I think I can help on writing the docs using md

🌚 Friends don't let friends browse without dark mode.

Sorry, it's true.