How-to ガイド
MDN Web Docs 執筆ガイドラインのこの章では、MDN Web Docs に協力する際の固有のタスクを達成するためのすべてのステップバイステップ情報を掲載しています。マークダウンの使用方法、用語集への項目の追加方法、ページの移動や削除方法などなどです。(GitHub を通して行う)協力の方法についての詳細は、協力ガイドラインをご覧ください。
メモ: この章では、あなたが協力ガイドラインをすべて読み、mdn/content
リポジトリーを熟知し、git と GitHub の使用方法を知っていることを想定しています。
- API リファレンスの書き方
このガイドでは、 MDN で API リファレンスを書くために必要なすべてのことを説明します。
- CSS プロパティの記事を作成するには
CSS 標準が進化するにつれて、新しいプロパティが常に追加されています。MDN の CSS リファレンスは、これらの開発に合わせて最新の状態に維持する必要があります。この文書では、CSS プロパティのリファレンスページを作成するためのステップごとの手順を説明します。
- HTTP ヘッダーの記事を作成するには
MDN の HTTP ヘッダーリファレンス は、ハイパーテキスト転送プロトコル (HTTP) のリクエストメッセージとレスポンスメッセージのヘッダーセクションの構成要素である HTTP のヘッダーフィールドを記述します。 HTTP トランザクションの操作引数を定義します。このページでは、 HTTP ヘッダーに対応する新しい MDN リファレンスページを作成する方法を説明します。
- Markdown で書くには
このページでは、 Markdown を使用してどのように MDN Web Docs のドキュメントを書くかを説明します。ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、 GFM では容易にサポートされていない MDN で行う必要のあるいくつかのことに対応するために、いくつかの拡張機能を追加しました。
- ウェブのエラーの記事を作成するには
MDN の JavaScript エラーリファレンス は 開発者コンソールで発生するエラーについて、ウェブ開発者を手助けすることを目的とした新しいプロジェクトです。この機能は、Firefox をお使いの場合に有効です。 JavaScript エラーに含まれる "Learn more" が問題の修正に役立つ追加のアドバイスを含む JavaScript エラーリファレンスにリンクしています。
- ページを作成および編集する方法
この記事では、新しい協力者に既存ページの編集と、新規ページを作成する手順を紹介します。
- 用語集の項目を書いたり参照したりするには
この記事では、 MDN Web Docs の用語集に項目を追加したりリンクしたりする方法について説明します。 また、用語集の項目のレイアウトと内容に関するガイドラインも提供します。 用語集には、ウェブやウェブ開発に関する MDN コンテンツを読む際に出くわすであろうすべての用語、専門用語、略語、頭字語の定義が記載されています。
- 画像やメディアの追加方法
文書に画像を追加するには、文書のフォルダーに画像ファイルを追加し、文書の
index.md
ファイルから<img>
要素または 同等の Markdown 構文 を使用して画像を参照してください。