Gitbook を使用して簡単な内部 Wiki を作成する方法

Gitbook を使用して簡単な内部 Wiki を作成する方法

GitBook は、ドキュメント サイトや企業の Wiki を構築できるプラットフォームです。これを使用して、コードから API、ソフトウェア製品の使用方法まで、あらゆる種類のものを文書化できます。





GitBook は、GitHub リポジトリと同様のプロセスを使用します。ドキュメントのメイン コピーは、「マスター」コピーとして機能します。次に、「ブランチ」に似た「ドラフト」を作成できます。





ps4コントローラーをps4から切断する方法

このプロセスにより、競合を処理または防止しながら、多くのユーザーが 1 つのドキュメント サイトで作業できるようになります。また、異なるブランチからの変更をマージする前にレビュー プロセスを通過させることもできます。





GitBook の使用を開始する方法

複数の中からお選びいただけます GitBook の価格 予定。価格は、GitBook をオープンソース プロジェクト、個人使用、またはプライベート チーム コラボレーションのいずれに使用しているかによって異なります。 GitBook は、オープン ソース プロジェクトで使用する場合は無料で使用できます。

GitBook のサポート 多くの利点を持つ人気のマークアップ言語、Markdown ウェブ上での執筆や文書化に。



GitBook は、 コードをホスト、保存、および編集するためのプラットフォームである GitHub . GitHub 資格情報を使用してサインインすることにより、GitBook アカウントを GitHub アカウントに直接リンクできます。

マウスが機能しないのはなぜですか
  1. GitBook にサインアップします。独自の GitHub アカウントをお持ちの場合は、 GitHub にサインアップ .
  2. サインインすると、GitBook によって新しい内部 wiki にリダイレクトされます。また、ウィキにいくつかのサンプル コンテンツを事前入力します。

GitBook インターフェイスの概要

GitBook には、ドキュメント サイトの構築と変更を可能にするいくつかの機能があります。





  1. トップ パネルでは、新しいドラフトを作成したり、変更履歴を表示したり、その他のディスカッションや添付ファイルを表示したりできます。
  2. 一番左のサイドバーでは、複数のスペースを作成できます。ドキュメント領域を分けて整理できるように、プロジェクトごとに別々のスペースを使用できます。サイドバーを展開または閉じることができます。
  3. 左側のパネルは、ドキュメント サイトのメニューとして機能します。ドキュメント サイト内のページを表示し、それを使用してグループとネストされたページを作成できます。提供されているリンクを使用して、サイト内を移動することもできます。
  4. 下部パネルには、バージョン管理プロセスに不可欠なボタンが含まれています。下書きの名前を追加したり、変更をマージしたり、レビューのために変更を送信したりできます。

新しい下書きを作成する方法

新しい変更リクエストを作成し、その中で変更を加えることで、新しいドラフトを作成できます。

  1. 上部パネルで、 変更依頼 .
  2. 右側に表示される新しいパネルで、 下書き タブ。これにより、アクティブな下書きがすべて表示されます。
  3. ここから、既存の下書きをクリックして開くことができます。新しい下書きを作成するには、 新しい変更リクエスト 、ページの読み込みが完了するまで待ちます。
  4. 下部のパネルで、 件名を入力してください .これにより、新しいドラフトに名前を付けることができるウィンドウが開きます。例えば、 新しいページ - コードベースの設定方法 .

ページとグループの作成方法

下書きができたら、ドキュメントに変更を加えることができます。 GitBook は変更をドラフト内に保存するため、マスター コピーには影響しません。左側のサイドバーを使用して、ページとページ グループを追加できます。





誰かに電話をかけるときに携帯電話番号をどのようにブロックしますか
  1. をクリックして新しいページを作成します。 新しいページ サイドバーの下部にあるリンクをクリックし、 新しいドキュメント ページ ドロップダウンから。または、既存のページの下にカーソルを合わせて、青色の プラス ボタン。
  2. 新しいページ グループを作成するには、 新しいページ をクリックして、 新グループ ドロップダウンからのオプション。
  3. ページまたはグループの横にある 3 つのドットをクリックして、ページの名前を変更できます。 名前を変更 .
  4. コンテンツの追加を開始して、新しいページに入力します。テキストや見出しなどの簡単なコンテンツを追加できます。 GitBook では、画像、添付ファイル、テーブル、タブ、コード スニペットなど、他のコンテンツ ブロックを追加することもできます。 YouTube の埋め込みや Google ドキュメントのコンテンツなど、他の統合を追加するオプションもあります。
  5. クリックしてください 差分ビュー 下部パネルのボタンをクリックして、下書きと元のマスター ドキュメント コピーの違いを表示します。
  6. コンテンツの作成が完了したら、 マージ 送信してマージ 、 また レビューのために送信 .

GitBook の上部パネルから共有リンクにアクセスできます。リンクを表示できるようにするには、ドラフトを終了してマスター ドキュメントのコピーを表示する必要があります。

  1. デフォルトでは、ドキュメンテーション サイトの可視性は「非公開」です。これは、検索エンジン経由ではなく、プライベート リンクを使用してドキュメント サイトにアクセスできることを意味します。上部パネルで、 未公開 ボタン。
  2. ドロップダウンから目的の表示設定を選択します。 GitBook は特定の可視性設定をロックする可能性があり、それらにアクセスするにはアップグレードが必要になる場合があることに注意してください。
  3. 表示設定のリストの下に、ドキュメント サイトを使用する他のユーザーと共有できるリンクがあります。このリンクをコピーして、他のユーザーと共有してください。
  4. リンクの下にある をクリックします。 リンクとドメインの設定 .ここで、カスタム ドメイン名をリンクしたり、URL の一部を変更したりできます。カスタム ドメインを使用している場合は、 Gitbook のドキュメント DNS を正しく構成する方法について説明します。

GitBook を使用したドキュメントの作成

GitBook を使用すると、ドキュメント サイトや会社の Wiki を共同で作成して作業することができます。 GitBook は、GitHub からブランチやマージなどの概念を借用して、マスター コピーを制御し、競合を管理します。

新しいドラフトを作成して、独自の変更をドキュメントに追加できます。下書き内で、コンテンツを変更したり、新しいページやページ グループを追加したりできます。変更が完了したら、それらをマージするか、レビューのために送信できます。

Java コードの内部ドキュメントを作成している場合は、Javadoc を調べてみてください。 Javadoc を使用すると、Java コードを自動的に文書化できます。