Docsbook
概要

クイックスタート:Docsbookでドキュメントサイトを公開する

学習内容:1つのソース(GitHubリポジトリ、ウェブサイト、または製品の説明)を、公開URL、検索インデックス、アナリティクスを備えた公開Docsbookドキュメントサイトに変換する方法。

開始する前に#

以下をすべて用意してください:

  • Chrome、Firefox、Safari、Edgeのいずれかの最新バージョン。
  • 1つのソースのみ:少なくとも1つの.mdファイルを含むGitHubリポジトリ、公開ウェブサイトのURL、または販売しているものを説明する2文。
  • ステップ3でサインインする方法:GitHubアカウント、Googleアカウント、Apple ID、またはワンタイムコードを受信できるメールアドレス。

ステップ3までは、クレジットカード、ビルドパイプライン、アカウントは必要ありません。

1
ステップ1 — 下書きを生成する
  1. docsbook.io/startを開きます。
  2. ソースを1つの入力欄に貼り付けます:ウェブサイトのURL、GitHubリポジトリのリンク、または製品についての1文です。Docsbookが種類を判別するため、選択するタイプはありません。
  3. Docsbookがソースを読み取るまで待ちます。各ステップで、読み取った内容と見つかった内容が示されます。

期待される結果:下書きサイトが専用の管理パネルで開き、ページ数、元になったソース、ブランディング、レイアウト、SEOの各セクションが表示されます。アカウントはまだ作成されていません。

2
ステップ2 — 下書きを開いて確認する
  1. 管理パネルの開くを押すか、プレビュー自体をクリックします。
  2. 生成されたページを実際のドキュメントサイトとして閲覧します。ヘッダー、サイドバーのツリー、アウトライン、パンくずリスト、前へ/次へがすべて機能します。
  3. パネルのアシスタントを使って文言を変更したり、サイトについて質問したりします。メッセージボックスでインタラクティブモードを開くと、横にチャットを表示した状態でサイトが開き、すべてのブロックをクリックできます。

期待される結果:下書きを読み、製品が正しく説明されているかどうかを確認できます。ウェブサイトやアイデアから作成した下書きは、公開するまでブラウザ内にのみ存在します。

3
ステップ3 — サインインして公開する
  1. パネルのフロントページにあるこのサイトを公開を押すか、ドキュメント自体のツールバーにある青いボタンを押します。まだ何も変更していない場合は公開、変更している場合は変更を保存、所有権の申立てリンクからアクセスした場合は所有権を申立てると表示されますが、3つとも同じ処理を行います。
  2. サインイン方法を選択します:GitHub、Google、Apple、またはワンタイムコードを使ったメール。
  3. サインインの手続きを完了します。

期待される結果:下書きが、公開アドレス、検索インデックス、アナリティクスを備えた公開中のDocsbookプロジェクトになります。記述した内容がやり直されることはありません。

サイトがGitHubリポジトリから作成され、Google、Apple、またはメールでサインインした場合、DocsbookはGitHubへのアクセス認証も求めます。認証を通じてリポジトリのファイルを読み取るためです。

4
ステップ4 — 公開したサイトを開く
  1. Docsbookに表示されたアドレスを開きます。アドレスは以下の形式です。
docsbook.io/{owner}/{repo}
  1. ヘッダーの検索ボックスを使うか、Cmd+K(WindowsおよびLinuxではCtrl+K)を押して、いずれかのページにあるフレーズを検索します。

期待される結果:ページが公開URLで読み込まれ、検索結果にそのフレーズが表示され、サインインしなくてもサイトを閲覧できます。

現在あるもの#

公開済みのドキュメントサイトがあります。公開URL、全文検索、AIエージェント向けのsitemap.xmlllms.txt、そして最初の訪問者からのページビューを記録する分析機能が備わっています。GitHubリポジトリから構築されたサイトは、アクセスされたときにリポジトリを再確認するため、ビルド手順なしでGitHubにプッシュするとページが更新されます。

次のステップ#

最初のサイトを公開する

リポジトリ、ウェブサイトの URL、または製品についての文章を貼り付けると、サインインする前に下書きを確認できます。

Updated

このページは役に立ちましたか?