ForHosting KIT · 文章作成・要約AI

Markdownからリンク付き目次を生成

Q: ジェネレーターは元のMarkdownを変更しますか？

変更しません。 新しい目次文字列と構造化された見出しレコードを返すだけで、入力されたソースは書き換えません。

見出しから、貼り付けてすぐ使えるリンク付き目次を作れます。例では Project Guide、Installation、Usage が階層で字下げされ、2つ目の Requirements には requirements-1 のアンカーが付くため、両方のリンクが働きます。ブラウザで無料で使えます。

無料
ブラウザで動作
登録不要
データは端末の外に出ません

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

見出しを手作業で写したりアンカー名を計算したりせずに、Markdown文書から読みやすいリンク付き目次を作成できます。ハッシュ記号を使うATX見出しと下線形式のSetext見出しを読み取り、フェンス付きコードブロック内の見出しらしい行は除外します。貼り付け可能なMarkdownと構造化データの両方を返し、入れ子の見出しには適切な字下げを、同名の見出しには異なるアンカーを割り当てます。処理は決定的でネットワークを使用せず、見出しがない場合は明確なエラーを返します。

Markdownを貼り付けて、そのまま使える構成を取得します

テキスト欄にMarkdownソース全体をご入力ください。ジェネレーターは文書を読む順序で走査し、<code>## インストール</code>のようなレベル1からレベル6までのATX見出しを認識します。さらに、本文行の次に等号を並べるレベル1、またはハイフンを並べるレベル2のSetext見出しにも対応しています。

結果の<code>toc</code>文字列は、README、ガイド、仕様書、ナレッジベース記事の冒頭付近へそのまま貼り付けられます。各項目には標準的なMarkdownリンク構文が使われ、文書内で最も浅い見出しと各見出しのレベル差に応じて字下げされます。そのため、レベル2から始まる抜粋でも元の階層を維持できます。

応答には、各項目のレベル、表示テキスト、生成アンカーを収めた構造化配列<code>headings</code>も含まれるため、独自のナビゲーションを構築する用途にもご利用いただけます。

見出しテキストが安定したリンクになる仕組みです

目次の各リンクは、対応する見出しに生成されるフラグメント識別子と一致して初めて正しく機能します。このジェネレーターでは、GitHubに近い予測可能な変換を行います。英字を小文字にし、空白をハイフンへ置き換え、多くの句読点を取り除く一方、英語以外の文字や数字も保持します。

インラインMarkdown装飾は表示ラベルとアンカーの両方から除去されるため、<code>**高度な**オプション</code>は読みやすい「高度なオプション」とアンカー<code>高度なオプション</code>になります。リンク先URLではなく、リンクに表示される文字列を保持します。

同じ正規化済み見出しが複数ある場合、最初は基本アンカー、2番目は<code>-1</code>、それ以降は連番の接尾辞を使用します。フェンス付きコードブロック内の見出しらしい行は無視し、ナビゲーション名として役立たない空の見出しも出力しません。

ドキュメント制作フローへ結果を組み込めます

最も簡単な使い方は、文書タイトルの下に<code>toc</code>文字列を貼り付け、見出しを変更するたびに再生成する方法です。自動処理では、ドキュメントの組み立て後にこの機能を呼び出し、返された文字列とリポジトリに保存した目次を比較できます。差分があれば、完全なMarkdownレンダラーを用意しなくても、レビュー時に更新を促せます。

静的サイト生成ツールでは構造化された見出しレコードを利用し、元の順序と入れ子を保ったサイドバー、ページ内索引、モバイル向けナビゲーションを構築できます。パーサーはネットワーク通信を行わず、埋め込みHTMLを実行せず、入力されたMarkdownも変更しません。見出しからナビゲーション情報だけを導出します。

処理を予測可能な範囲に保つため、入力は100万文字までです。

活用例

READMEの索引を常に最新に保ちます

リリース作業で節の追加、改名、並べ替え、入れ子化を行った後に、リンク付き構成を再生成できます。

ドキュメント用ナビゲーションを作成します

構造化された見出し配列を使い、別の構成表を手作業で管理せずにサイドバーや索引を構築できます。

継続的インテグレーションで文書を検査します

生成結果と保存済みの目次を比較し、コードレビュー中に古くなったナビゲーションを検出できます。

よくある質問

どのMarkdown見出し形式に対応していますか？

H1からH6までのATX見出しと、H1またはH2のSetext見出しに対応しています。フェンス付きコードブロック内の見出しらしい文字列は無視します。

同じ見出し名が繰り返された場合はどうなりますか？

最初の見出しは基本アンカーを使います。同じ正規化済みテキストを持つ後続の見出しには、-1や-2などの数値接尾辞を付けます。

ジェネレーターは元のMarkdownを変更しますか？

変更しません。新しい目次文字列と構造化された見出しレコードを返すだけで、入力されたソースは書き換えません。

アンカー名はどのように作られますか？

GitHubと同じ方式で、英字は小文字になり、空白はハイフンに変わり、ほとんどの記号は除かれます。英語以外の文字や数字は残ります。Advanced **options** という見出しは advanced-options になります。

コードブロック内の見出しも目次に入りますか？

いいえ。コードブロックの中にある見出しのような行は無視されるため、Markdownの書き方を説明するチュートリアルでも安心です。空の見出しも除かれ、見出しが1つもない文書では空の目次ではなく分かりやすいエラーになります。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/dev2/markdown-toc-generate

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/dev2/markdown-toc-generate \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"# Project Guide\n\n## Installation\n\n### Requirements\n\n## Usage"}'

const res = await fetch("https://api.kit.forhosting.com/dev2/markdown-toc-generate", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "text": "# Project Guide\n\n## Installation\n\n### Requirements\n\n## Usage"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev2/markdown-toc-generate",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "text": "# Project Guide\n\n## Installation\n\n### Requirements\n\n## Usage"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev2/markdown-toc-generate", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"text":"# Project Guide\\n\\n## Installation\\n\\n### Requirements\\n\\n## Usage"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"text":"# Project Guide\n\n## Installation\n\n### Requirements\n\n## Usage"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev2/markdown-toc-generate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "text": "# Project Guide\n\n## Installation\n\n### Requirements\n\n## Usage"
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev2.markdown_toc_generate",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

制限

max_chars 1000000

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

技術的な注記

ドキュメント制作フローへ結果を組み込めます

段落、リスト、コード、表があっても有効な見出しがなければ、空の目次ではなく<code>invalid_input</code>エラーを返します。

技術的な質問

文書に見出しがない場合はどうなりますか？

Markdown見出しが見つからなかったことを説明するinvalid_inputエラーを返します。

APIリクエスト1回の料金はいくらですか？

APIリクエスト1回は$0.002です。ブラウザー版では同じ決定的なロジックをローカルで実行できます。

KITの完全なドキュメントを見る →

Markdownからリンク付き目次を生成

無料で実行

Markdownを貼り付けて、そのまま使える構成を取得します

見出しテキストが安定したリンクになる仕組みです

ドキュメント制作フローへ結果を組み込めます

活用例

READMEの索引を常に最新に保ちます

ドキュメント用ナビゲーションを作成します

継続的インテグレーションで文書を検査します

よくある質問

関連ツール

開発者向け — APIアクセス

エンドポイント

お使いのスタックから呼び出す

リクエスト例

レスポンス例

料金

制限

エラー

技術的な注記

ドキュメント制作フローへ結果を組み込めます

技術的な質問

ありがとう