動機

優れたドキュメントを作成すると、プロジェクトをよりよく理解するのに役立ちます.また、多くの時間を節約できます.優れたドキュメントを作成して紹介することは、大規模なプロジェクトにとって退屈な作業です.このブログでは、大きなプロジェクトのドキュメントを維持する方法について説明します.ドキュメントには Docz を選択しました.ブログの残りの部分を読んで、その理由を見つけてください.

前提条件

React JS の基本

タイプスクリプトの基本

Github の基本

プロジェクトの技術的ニーズ

ノード JS - https://nodejs.org/en/

ビジュアル スタジオ コード - https://code.visualstudio.com/

Github アカウント - https://github.com/

ソフトウェア ドキュメントのすべてのニーズに Docz を選んだ理由

Gatsby を利用しているため、テーマを簡単に変更でき、ドキュメントの見栄えを良くすることができます.

Docz には複雑な構成はなく、非常に単純です.

MDX は最近普及し、広く使用されています. Docz には、MDX を作成する機能があります.

最後に、Docz で typescript のサポートが利用可能になりました. Typescript はプロジェクトの保守を容易にし、Docz との統合により、ドキュメントの作成が非常に簡単になります.詳細については、ブログをお試しください.

始め方（typescriptでnextjsを初期化）

プロジェクトの初期化は非常に簡単です.これについて nextjs チームに感謝します.彼らはすでに typescript ボイラープレートを持っているので、これをすばやく開始するのに役立ちます.試す

npx create-next-app --ts nextdoczts

また

npx create-next-app --typescript nextdoczts

残りを知りたいですか?リンクをたどってください - https://aviyel.com/post/824/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript