跳至主要内容

让我们一起贡献！ 🚀

感谢您对参与该项目的兴趣。以下是一些核心原则和简化的项目结构，旨在使您的贡献过程更有效率和更有效。

📋 核心原则​

  1. 我们专注于速查表：我们的主要目标是提供简洁易用的速查表。所有代码示例都应简单、易于搜索，并可直接复制粘贴。

  2. 可折叠的解释：保持解释简短明了，限制在 1-2 句话。对于更深入的解释，使用 details 标签提供更多上下文。

  3. 仅限 React + TypeScript：我们专注于 React 和 TypeScript。React 的生态系统非常庞大，因此我们无法涵盖所有内容。如果您认为有必要，可以考虑为专门的主题（例如 React + Apollo GraphQL）维护单独的列表。我们也不打算说服人们使用 TypeScript；我们在这里是为了帮助那些已经选择使用它的人。

  4. 添加 TypeScript Playground 链接：对于超过四行的代码示例，请包含指向 TypeScript Playground 的链接。使用默认的 TypeScript Playground 选项以获得最佳体验。

您的贡献将帮助无数开发者，包括未来的您！ 🙌

📁 项目结构​

  • 内容位于 /docs 中：所有内容都位于此处。
    • /docs/basic 中的内容编译到 README.md 中，以确保在 GitHub 上易于阅读。
  • /website 文件夹：此部分使用 /docs 中的内容。它是一个 Docusaurus 2 网站，并包含 Algolia 搜索。非常感谢 Docusaurus 和 Algolia 团队的支持！

该网站部署在 Netlify 上，位于 swyx 的个人帐户下。

要本地运行文档站点，请按照以下步骤操作

yarn # Install dependencies
## Ensure dependencies are also installed in /website
cd website && yarn start

以下是开发服务器成功启动时预期输出的示例

yarn run v1.22.4
warning package.json: No license field
$ docusaurus start
Starting the development server...

✔ Client
  Compiled successfully in 9.61s

ℹ ｢wds｣: Project is running at http://localhost:3000/
ℹ ｢wds｣: webpack output is served from /
ℹ ｢wds｣: Content not from webpack is served from /Users/wanshawn/Work/react-typescript-cheatsheet/website
ℹ ｢wds｣: 404s will fallback to /index.html

✔ Client
  Compiled successfully in 116.41ms

让我们携手合作，增强此资源，使其对开发者社区更有价值！ 🌟👩‍💻👨‍💻