ページの作成、編集、移動、削除方法

ページの作成

MDN Web Docs のすべてのページは Markdown 形式で書かれています。内容は index.md という名前のファイルに書かれ、自分自身で固有のディレクトリーに格納されます。ディレクトリー名はページの名前を表します。例えば、 align-content が新しい CSS プロパティであり、新しいリファレンスページを作成したい場合、 en-us/web/css に align-content という名前のフォルダーを作成し、その中に index.md という名前のファイルを作成してください。

たくさんの異なるページの種類があり、特定の構造とそれに対応しているページテンプレートがありますので、取りかかる場合はそれをコピーしてください。

文書の index.md ファイルは、 title、slug、page-type を定義するフロントマターから始めなければなりません。このフロントマターの情報はすべて前述のページテンプレートにあります。また、同様の文書の index.md 内のフロントマターを参照すると役立つかもしれません。

ページを作成する一般的なステップは次のようになります。

1. 作業用に最新の新しいブランチで始めます。

   bash

   cd ~/repos/mdn/content
   git checkout main
   git pull mdn main
   # "npm install" を実行することで、依存関係が最新であることを確認します。
   npm install
   git checkout -b my-add
   

2. 1つ以上の新しい文書フォルダーを作成し、それぞれに index.md ファイルを作成します。

3. 新しいファイルを追加してコミットし、新しいブランチをフォークにプッシュします。

   bash

   git add files/en-us/folder/you/created
   git commit -m "変更に関する適切なメッセージ"
   git push -u origin my-add
   

4. プルリクエストを作成します。

ページの移動

1つまたは複数の文書、または文書のツリー全体を移動するのは簡単です。詳細を処理する特別なコマンドを作成してあるからです。

npm run content move <from-slug> <to-slug> [locale]

移動したい既存の文書のスラッグ（例: Web/HTTP/Guides/Authentication）と新しい場所のスラッグ（例: Web/HTTP/Guides/Auth）を指定し、それに続いてオプションで既存の文書のロケール（デフォルトでは en-US）を指定します。

移動させたい既存の文書に子文書がある場合（つまり文書ツリーを表している場合）、npm run content move コマンドはツリー全体を移動します。

例えば、/en-US/Web/HTTP/Guides/Authentication のツリー全体を/en-US/Web/HTTP/Guides/Auth に移動させたい場合、次のような手順を実行します。

1. 作業用に新しいブランチで始めます。

   bash

   cd ~/repos/mdn/content
   git checkout main
   git pull mdn main
   # "npm install" を実行することで、依存関係が最新であることを確認します。
   npm install
   git checkout -b my-move
   

2. 移動を実行します（新しいファイルを作成するだけでなく、既存のファイルを削除、変更します）。

   bash

   npm run content move Web/HTTP/Guides/Authentication Web/HTTP/Guides/Auth
   

3. ファイルを移動したら、他のコンテンツファイル内のそれらのファイルへの参照も更新する必要があります。以下のコマンドを使用すると、すべての参照を自動的に一括更新します。

   bash

   node scripts/update-moved-file-links.js
   

4. 削除、作成、変更したファイルをすべて追加してコミットし、ブランチをフォークにプッシュします。

   bash

   git add .
   git commit -m "Web/HTTP/Guides/Authentication から Web/HTTP/Guides/Auth へ移動"
   git push -u origin my-move
   

5. プルリクエストを作成します。

ページの削除

MDN Web Docs から文書を除去されるべきなのは、特別な事情がある場合だけです。ページの削除を考えている場合は、最初に MDN Web Docs チャットルームで MDN Web Docs チームと相談してください。

ページの移動と同じように、 1 つまたは複数の文書、あるいは文書のツリー全体を削除するのも簡単です。

npm run content delete <document-slug> [locale] -- --redirect <redirect-slug-or-url>

リダイレクト先は、外部 URL または MDN Web Docs 内の別のページに設定できます。

削除したい既存の文書のスラッグ（例: Web/HTTP/Guides/Authentication）を指定し、オプションで既存の文書のロケール（デフォルトでは en-US）を続けてください。

削除したい既存の文書に子文書がある（つまり文書ツリーを表している）場合は、 -r, --recursive オプションも指定しなければなりません。

例えば、 /en-US/Web/HTTP/Guides/Authentication のツリー全体を削除したい場合は、以下の段階を踏むことになります：

1. 作業用に新しいブランチで始めます。

   bash

   cd ~/repos/mdn/content
   git checkout main
   git pull mdn main
   # "npm install" を実行することで、依存関係が最新であることを確認します。
   npm install
   git checkout -b my-delete
   

2. 削除をリダイレクト付きで実行します。

   bash

   npm run content delete Web/HTTP/Guides/Authentication --recursive -- --redirect /en-US/path/of/target/page
   

3. 削除したファイルをすべて追加してコミットし、ブランチをフォークにプッシュします。

   bash

   git commit -a
   git push -u origin my-delete
   

4. プルリクエストを作成します。

npm run content delete "Mozilla/Add-ons/WebExtensions/Debugging_(before_Firefox_50)" -- --redirect <redirect-slug-or-url>

MDN Web Docs からコンテンツを除去されると、必然的に既存のコンテンツも更新されることになります。多くの記事は他にもリンクしているので、除去されたコンテンツは他の場所で参照される可能性が高いです。リダイレクトを追加することで、コンテンツの削除による影響を軽減することができます。しかし、変更を反映するためにコンテンツを編集し、削除のプルリクエストと一緒にコンテンツの編集を記載することがベストプラクティスです。

既存ページの編集

ページを編集するには、 content リポジトリー（翻訳記事は translated-content リポジトリー）でページのソースを見つける必要があります。最も簡単な方法は、編集したいページに移動して、ページの一番下にある "View the source on GitHub" のリンクをクリックすることです。

変更のプレビュー

ローカルでページを編集している場合、変更した内容がどのように見えるかを確認するには、コンテンツリポジトリーのフォルダーに移動し、 CLI のコマンド npm start を実行し、ブラウザーで localhost:5042 に移動し、ページに移動して表示させることができます。検索ボックスにタイトルを入力すると、簡単に見つけることができます。ソースを編集すると、プレビューされたページがブラウザー上でライブで更新されます。

ファイルの添付

記事にファイルを添付するには、記事の index.md ファイルと同じディレクトリーにファイルを置き、通常 <a> 要素を介してページ内にファイルを含めてください。