أنشئ فهرسًا مرتبطًا من Markdown
حوّل عناوينك إلى فهرس بروابط جاهز للصق: في المثال تُزاح Project Guide وInstallation وUsage حسب مستواها، ويحصل Requirements الثاني على المرساة requirements-1 كي يعمل الرابطان كلاهما. مجاناً في متصفحك.
- مجاني
- يعمل في متصفحك
- دون تسجيل
- بياناتك لا تغادر جهازك
شغّل الأداة مجانًا
حوّل مستند Markdown إلى فهرس واضح ذي روابط من دون نسخ العناوين أو حساب أسماء المراسي يدويًا. يقرأ المولّد عناوين ATX المكتوبة بعلامات الشباك وعناوين Setext المكتوبة بخطوط تحتية، ويتجاهل الأسطر الشبيهة بالعناوين داخل كتل التعليمات البرمجية المسيّجة، ثم يعيد Markdown جاهزًا للصق وبيانات منظّمة. تحصل العناوين المتداخلة على المسافة البادئة المناسبة، وتحصل العناوين المكررة على مراسٍ مختلفة. المعالجة حتمية ولا تستخدم الشبكة، ويظهر خطأ واضح إذا لم يتضمن المستند أي عناوين.
ألصق Markdown واحصل على مخطط جاهز للاستخدام
أدخل مصدر Markdown الكامل في حقل النص. يفحص المولّد المستند وفق ترتيب القراءة ويتعرّف على عناوين ATX من المستوى الأول حتى المستوى السادس، مثل <code>## التثبيت</code>. كما يتعرّف على عناوين Setext، حيث يلي سطر النص صف من علامات المساواة للمستوى الأول أو الشرطات للمستوى الثاني.
تتضمن النتيجة سلسلة <code>toc</code> يمكنك لصقها مباشرة قرب بداية ملف README أو دليل أو مواصفة أو مقالة في قاعدة معرفة. يستخدم كل بند صيغة روابط Markdown المعتادة، وتعكس المسافة البادئة الفرق بين مستواه ومستوى أقل عنوان عمقًا في المستند. تحافظ هذه الطريقة على التسلسل الهرمي حتى إذا بدأ مقتطف ما من المستوى الثاني بدلًا من الأول.
تتضمن الاستجابة أيضًا مصفوفة منظّمة باسم <code>headings</code> تحتوي على المستوى والنص الظاهر والمرساة المولّدة لكل بند، ولذلك تستطيع التطبيقات إنشاء تنقل مخصص بينما تستخدم الأدوات النصية الفهرس الجاهز.
افهم طريقة تحويل نص العنوان إلى رابط ثابت
لا يكون الفهرس مفيدًا إلا عندما يشير كل رابط إلى معرّف الجزء نفسه الذي يُنشأ لعنوانه. يطبق هذا المولّد تحويلًا متوقعًا شبيهًا بأسلوب GitHub: يحوّل الأحرف اللاتينية إلى صغيرة، ويستبدل المسافات بشرطات، ويحذف معظم علامات الترقيم، مع الاحتفاظ بحروف اللغات الأخرى والأرقام. تُزال زخرفة Markdown المضمّنة من التسمية الظاهرة والمرساة؛ لذلك يصبح <code>خيارات **متقدمة**</code> تسمية مقروءة هي «خيارات متقدمة» ومرساة <code>خيارات-متقدمة</code>.
تحتفظ الروابط بالنص المعروض بدل عنوان URL المقصود. إذا ظهر العنوان المنظّف نفسه أكثر من مرة، تستخدم النسخة الأولى المرساة الأساسية، وتحصل الثانية على اللاحقة <code>-1</code>، ثم يستمر العد للنسخ اللاحقة. يتجاهل المحلل الأسطر الشبيهة بالعناوين داخل كتل التعليمات البرمجية المسيّجة، ولا يخرج العناوين الفارغة لأنها لا توفر تسمية تنقل مفيدة.
استخدم النتيجة ضمن مسارات عمل التوثيق
أبسط مسار عمل هو لصق سلسلة <code>toc</code> أسفل عنوان المستند وإعادة توليدها كلما تغيّرت العناوين. في الأتمتة، استدعِ القدرة بعد تجميع التوثيق، ثم قارن السلسلة المعادة بالفهرس المحفوظ في نظام الإصدارات. يمكن للاختلاف أن يطلب تحديثًا أثناء المراجعة من دون الحاجة إلى عارض Markdown كامل.
تستطيع أدوات إنشاء المواقع الثابتة بدلًا من ذلك استهلاك سجلات العناوين المنظّمة لبناء أشرطة جانبية أو فهارس صفحات أو تنقل للهواتف مع الحفاظ على ترتيب المصدر وتداخله. لا يجري المحلل أي اتصال بالشبكة، ولا ينفّذ HTML مضمّنًا، ولا يعدّل Markdown المرسل. إنه يشتق بيانات التنقل من العناوين فقط.
يقتصر الإدخال على مليون حرف كي تظل المعالجة محدودة ومتوقعة.
حالات الاستخدام
حافظ على تحديث فهرس ملف README
أعد توليد المخطط المرتبط بعد إضافة الأقسام أو إعادة تسميتها أو ترتيبها أو تداخلها أثناء إصدار جديد.
أنشئ تنقلًا خاصًا بالتوثيق
استخدم مصفوفة العناوين المنظّمة لإنشاء شريط جانبي أو فهرس صفحة من دون صيانة مخطط ثانٍ يدويًا.
تحقق من التوثيق في التكامل المستمر
قارن النتيجة المولّدة بالفهرس المحفوظ ونبّه إلى التنقل القديم أثناء مراجعة التعليمات البرمجية.
الأسئلة الشائعة
ما أنماط عناوين Markdown المدعومة؟
تُدعم عناوين ATX من H1 حتى H6 وعناوين Setext من النوع H1 أو H2. تُتجاهل الأسطر الشبيهة بالعناوين داخل كتل التعليمات البرمجية المسيّجة.
ماذا يحدث عند تكرار أسماء العناوين؟
يستخدم العنوان الأول المرساة الأساسية. وتحصل العناوين اللاحقة ذات النص المنظّف نفسه على لواحق رقمية مثل -1 و-2.
هل يعدّل المولّد ملف Markdown الخاص بي؟
لا. يعيد سلسلة فهرس جديدة وسجلات عناوين منظّمة، ولا يعيد كتابة النص المصدر.
كيف تُبنى أسماء المراسي؟
على طريقة GitHub: تتحول الحروف إلى صغيرة، والمسافات إلى شرطات، وتُحذف معظم علامات الترقيم، مع الإبقاء على حروف اللغات الأخرى وأرقامها. فالعنوان Advanced **options** يعطي المرساة advanced-options.
هل تدخل العناوين الموجودة داخل كتل الكود في الفهرس؟
لا. تُتجاهل الأسطر التي تشبه العناوين داخل كتل الكود، وهذا مهم في الدروس التي تشرح صيغة Markdown. كما تُستبعد العناوين الفارغة، ويعطي المستند الخالي من أي عنوان خطأً واضحاً بدلاً من فهرس فارغ.
أدوات ذات صلة
للمطوّرين — الوصول عبر API
كل ما في هذه الصفحة متاح برمجيًا. هذا القسم موجّه للفرق التقنية التي تريد ربط الأداة بأنظمتها الخاصة؛ بقية المستخدمين يمكنهم استخدام الأداة أعلاه مباشرة دون الحاجة لقراءة ما يلي.
الـEndpoint
صادِق على طلبك بترويسة Bearer، وأرسل طلب POST واحدًا لتدخل مهمتك قائمة التنفيذ فورًا؛ ثم تستلم النتيجة عبر 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"
}
}الواجهة غير متزامنة: تستلم task_id فور الإرسال، ويمكنك الاستعلام عن الحالة بمعدل طلب واحد في الثانية.
الأسعار
السعر معلن كما تراه: لا tokens ولا نظام نقاط؛ وإن فشلت المهمة فلن تُحاسَب عليها.
الحدود
max_chars | 1000000 |
الأخطاء
| HTTP | الرمز | المعنى |
|---|---|---|
401 | unauthorized | مفتاح الوصول مفقود أو غير صالح؛ تحقق من ترويسة Bearer في طلبك. |
402 | insufficient_balance | رصيدك لا يكفي لتنفيذ هذه المهمة؛ أعد شحن الرصيد ثم أعد المحاولة. |
404 | unknown_type | نوع المهمة المطلوب غير موجود في الكتالوج — راجع الاسم المرسل في الطلب. |
429 | rate_limited | تجاوزت الحد المسموح من الطلبات؛ انتظر قليلًا ثم أعد المحاولة. |
ملاحظات تقنية
استخدم النتيجة ضمن مسارات عمل التوثيق
إذا احتوى المستند على فقرات أو قوائم أو تعليمات برمجية أو جداول من دون عنوان صالح، فسيعيد خطأ <code>invalid_input</code> بدلًا من فهرس فارغ يبدو ناجحًا لكنه غير مفيد.
أسئلة تقنية
ماذا يحدث إذا لم يتضمن المستند عناوين؟
يعيد الطلب خطأ invalid_input يوضح أنه لم يُعثر على أي عناوين Markdown.
كم تبلغ تكلفة طلب API واحد؟
يكلف كل طلب API مبلغ $0.002. ويمكن لنسخة المتصفح تشغيل المنطق الحتمي نفسه محليًا.