发布于 2026-01-06 1 阅读
0

让我们一起构建 React 和 TypeScript 文档! React 和 TypeScript 的起源 灵感来源 贡献的前提条件 对本项目的期望 帮助 React 和 TypeScript 的方式

让我们一起构建 React 和 TypeScript 文档

React 和 TypeScript

它的起源

灵感

贡献的前提条件

对这个项目的期望

提供帮助的方式

React 和 TypeScript

GitHub 标志 AryanJ-NYC / reactandtypescript.dev

使用 TypeScript 和 React 编写的文档。使用 docz 编写。

React 和 TypeScript

描述

我创建React And TypeScript 项目是为了学习 React 和 TypeScript。我决定将我的笔记分享到网上,也就是你现在看到的这些。我希望这个项目能够发展壮大,成为React 和 TypeScript 文档的权威来源

本地运行

在项目根目录的终端中运行:

  1. yarn
  2. yarn start

贡献

感谢您对React 和 TypeScript非官方文档的贡献感兴趣。请访问贡献页面,了解更多关于如何为本项目做贡献的信息。




它的起源

似乎每次我尝试用 TypeScript 创建一个 React 项目时,都会花费太多时间在正确编写 TypeScript 代码上。我开始编写非官方的 React 和 TypeScript 文档,是为了记录我自己在使用 TypeScript 和 React 时的笔记(同时也是为了体验 Gatsby 和docz)。

灵感

诚然,这个想法和很多内容都大量借鉴了@swyxTypeScript 速查表。我认为网站可以添加比标准 GitHub README 文件更多的功能(例如搜索)。

贡献的前提条件

我认为参与这个项目不会特别困难。但是,需要具备一定的 React 和 Markdown 经验:

  1. 贡献者需要具备 React 经验,才能验证他们提交到代码仓库的文档是否正确。
  2. 贡献者需要具备 Markdown 编写经验才能实际编写文档(整个存储库基本上都是一堆 mdx 文件)。

对这个项目的期望

我希望React 和 TypeScript能成为用户查找 React 和 TypeScript 文档的首选平台。此外,我也希望它能为初学者提供一个安全的平台,让他们可以提交 pull request,并通过实际编写文档来学习如何将 TypeScript 与 React 结合使用。

提供帮助的方式

最大的帮助将来自一个活跃的 GitHub 社区,那里充满了新的想法(问题)和贡献者。不过,我也理解这对某些人来说可能不太现实。没关系!请通过分享这篇文章、分享 GitHub 代码库,或者仅仅是在 GitHub 代码库上点击“星标”来表达您的支持。

GitHub 标志 AryanJ-NYC / reactandtypescript.dev

使用 TypeScript 和 React 编写的文档。使用 docz 编写。

React 和 TypeScript

描述

我创建React And TypeScript 项目是为了学习 React 和 TypeScript。我决定将我的笔记分享到网上,也就是你现在看到的这些。我希望这个项目能够发展壮大,成为React 和 TypeScript 文档的权威来源

本地运行

在项目根目录的终端中运行:

  1. yarn
  2. yarn start

贡献

感谢您对React 和 TypeScript非官方文档的贡献感兴趣。请访问贡献页面,了解更多关于如何为本项目做贡献的信息。




文章来源:https://dev.to/aryanjnyc/let-s-build-react-and-typescript-documentation-together-9i2