ウェブエディタの始め方

ウェブエディタでドキュメントを作成・編集する方法を学ぶ

ウェブエディタは、ブラウザでドキュメントを直接作成・編集・レビューできるビジュアルインターフェースです。

• ビジュアル編集: 公開時の見え方をそのまま反映する WYSIWYG エディタで編集できます。
• Git 同期: 変更はすべて、バージョン管理のために Git リポジトリへ自動的に同期されます。
• チームでの共同作業: 複数人が同時にドキュメント作業を行えます。
• コンポーネントの追加: スラッシュコマンドでコールアウト、コードブロックなどのコンポーネントを追加できます。
• セットアップ不要: ダッシュボードからすぐに執筆を開始できます。

ウェブエディタのワークフロー

通常、ウェブエディタでは次のように作業します：

1. ブランチを選択する

   ブランチを作成するか、デプロイブランチに直接変更を加えます。変更を本番公開する前にプレビューできるよう、ブランチの作成をおすすめします。

2. ファイルを開く

   サイドバーで既存のファイルに移動するか、ファイルエクスプローラーで新規作成します。

3. コンテンツを編集する

   ウェブエディタで編集します。右上のトグルでビジュアルモードとMarkdownモードを切り替えて、使いやすい方を試してください。

4. 変更をプレビューする

   ビジュアルモードでは、ライブサイトでの表示を確認できます。これを使って見た目や動作に問題がないか検証してください。

5. 変更を公開する

   デプロイブランチで作業している場合は、ウェブエディタから直接公開できます。その他のブランチでは、公開前にレビュー用のプルリクエストを作成します。

エディターモード

ウェブエディタには、さまざまな編集の好みやニーズに対応する2つのモードがあります。エディターツールバー右上のトグルで編集モードを切り替えられます。

ビジュアルモード

ビジュアルモードは、エディタで行った変更がそのままドキュメントサイトに反映される WYSIWYG 体験を提供します。変更結果をリアルタイムに確認したい場合に最適です。

/ を押してコンポーネントメニューを開き、スタイル付きコンテンツ、コールアウト、コードスニペット、その他のコンポーネントを追加します。

Markdownモード

Markdownモードでは、ドキュメントの基盤となるMDXコードに直接アクセスできます。コンポーネントのプロパティを厳密に制御したい場合や、Markdown構文で記述したい場合に最適です。

次のステップ

• 基本的な Git の概念 を学ぶ。
• ブランチでのコラボレーションのベストプラクティスを学ぶ。
• ウェブエディタでのコンテンツ管理を学ぶ。
• さまざまなシナリオにおける公開オプションを理解する。