メインコンテンツへスキップ

一緒に貢献しましょう! 🚀

このプロジェクトへの貢献に興味を持っていただきありがとうございます。ここでは、あなたの貢献プロセスをより効率的かつ効果的にするための、いくつかのコア原則と簡略化されたプロジェクト構造を紹介します。

📋 コア原則

  1. チートシートに特化しています:私たちの主な目標は、簡潔で使いやすいチートシートを提供することです。すべてのコード例はシンプルで、簡単に検索でき、コピーアンドペーストの準備ができています。

  2. 折りたたみ可能な説明:説明は短く要領よく、1〜2文に制限します。より詳しい説明については、detailsタグを使用して追加のコンテキストを提供します。

  3. React + TypeScriptのみ:私たちはReactとTypeScriptに焦点を当てています。Reactのエコシステムは広大なので、すべてをカバーするつもりはありません。ニーズがあると思われる場合は、React + Apollo GraphQLなどの専門トピックに対して個別のリストを管理することを検討してください。また、人々にTypeScriptの使用を強制するつもりはありません。ここでは、すでにTypeScriptを使用することを選択した人を支援します。

  4. TypeScript Playgroundのリンクを追加します:4行を超えるコード例の場合、TypeScript Playgroundへのリンクを含めます。最高のエクスペリエンスを得るには、デフォルトのTypeScript Playgroundオプションを使用します。

あなたの貢献は、あなた自身の将来の自己を含む無数の開発者たちを助けるでしょう! 🙌

📁 プロジェクト構造

  • /docs内のコンテンツ:すべてのコンテンツはここにあります。
    • /docs/basic内のコンテンツはREADME.mdにコンパイルされて、GitHubで簡単に読めるようになっています。
  • /websiteフォルダ:この部分は/docs内のコンテンツを消費します。これはDocusaurus 2サイトで、Algolia検索が含まれています。DocusaurusチームとAlgoliaチームのサポートに感謝します!

ウェブサイトは、snyxの個人アカウントでNetlifyにデプロイされます。

docsiteをローカルで実行するには、次の手順に従います。

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

このリソースを強化して、開発者コミュニティにとってさらに価値のあるものにするために、協力しましょう! 🌟👩‍💻👨‍💻