GitHub Docs ドキュメントへの投稿

GitHub Docs チームがドキュメントを作成する方法と、投稿する方法について説明します。

推奨

GitHub Docs コンテンツには、いくつかの方法でコントリビュートすることができます。

次のベストプラクティスに従って、ユーザーフレンドリでわかりやすいドキュメントを作成します。

このガイドに従って、 GitHubのドキュメントが一貫性を保ち、読者が理解できる明確なパターンに従っていることを確認します。

Get set up to contribute

GitHub Codespacesを使用して、GitHub Docsのドキュメントを操作できます。

Get set up to contribute

コマンドラインで Git を使用して変更をコミットし、ドキュメントリポジトリにプッシュできます。

Write and format content

Markdown と Liquid を使用すると、コンテンツの書式設定、再利用可能なコンテンツの作成、 GitHub Docsのさまざまなバージョンのコンテンツの書き込みを行うことができます。

Understand the GitHub approach to docs

次のベストプラクティスに従って、ユーザーフレンドリでわかりやすいドキュメントを作成します。

Follow the style guide and content model

すべての記事にはいくつかの標準的な要素が含まれており、条件付きまたは省略可能な要素を含めることができます。また、記事内のコンテンツには標準的な順序を使用します。

Get set up to contribute

GitHub Docs コンテンツには、いくつかの方法でコントリビュートすることができます。

Write and format content

このガイドでは、 GitHub Docsのダイアグラムを作成するタイミングと方法について説明します。

Understand the GitHub approach to docs

GitHub Docs で公開されるすべてのコンテンツは、これらの基本要件を満たしている必要があります。

Understand the GitHub approach to docs

ドキュメント哲学は、作成するコンテンツとその作成方法を指南するものです。

37 の 1-9 の表示