Command Palette

Search for a command to run...

مو

مولد ماركداون TOC

قم بإنشاء جدول محتويات مرتبط من عناوين Markdown

ما هو مولد جدول المحتويات؟

يقرأ منشئ جدول محتويات Markdown العناوين الموجودة في مستند Markdown وينتج قائمة متداخلة من الروابط التي تنتقل إلى كل قسم. تقوم بلصق Markdown الخاص بك، وتقوم الأداة بإرجاع كتلة جاهزة للاستخدام مثل القائمة النقطية حيث يكون كل سطر عبارة عن رابط `[Heading](#anchor)`. فهو يوفر عليك كتابة المخطط التفصيلي يدويًا ومن تخمين معرف المرساة الذي سيخصصه العارض لكل عنوان.

قلب الأداة هو المرساة slug. يقوم GitHub وGitLab ومعظم مولدات المواقع الثابتة بتحويل عنوان مثل "Getting Started" إلى معرف `getting-started` عن طريق خفض النص وإزالة علامات الترقيم واستبدال المسافات بواصلات. يطبق هذا المولد نفس القاعدة، بما في ذلك اللاحقة الرقمية (`-1`، `-2`) التي يضيفها GitHub عندما يشترك عنوانان في slug، وبالتالي فإن الروابط التي ينتجها تحل للمعرفات الدقيقة التي ستعرضها صفحة README أو المستندات الخاصة بك. يقرأ كلاً من عناوين ATX (السطور التي تبدأ بـ `#`) وعناوين Setext (النص تحته خط بـ `=` أو `-`)، ويتجاهل أي `#` التي تظهر داخل كتلة التعليمات البرمجية المسيجة. يتم التعامل مع العناوين التي تحمل تنسيقًا مضمنًا بنفس الطريقة: يتم تقليل الرابط أو النص الغامق أو الرمز المضمن أو الصورة داخل العنوان إلى نصه العادي للملصق، ويتم إنشاء المرساة من نفس السلسلة النظيفة، لذلك يتفق الاثنان دائمًا.

كل شيء يعمل في متصفحك. يتم تحليل Markdown الذي تقوم بلصقه باستخدام JavaScript من جانب العميل ولا يترك جهازك أبدًا، لذلك لا يوجد تحميل ولا حساب ولا تتبع للمحتوى الخاص بك. تعمل الأداة دون اتصال بالإنترنت بمجرد تحميل الصفحة، وتتيح لك اختيار مستويات العناوين التي تريد تضمينها، والتبديل بين القوائم النقطية والمرقمة، والتحكم في المسافة البادئة، وتقوم بتحديث المخطط التفصيلي لحظة تغيير الخيار.

كيفية استخدام مولد Markdown TOC؟

  1. الصق التخفيضات الخاصة بك

    قم بإسقاط مستند Markdown الكامل أو README في مربع الإدخال. يتم تخطي العناوين الموجودة داخل كتل التعليمات البرمجية المسيجة تلقائيًا.

  2. اختر مستويات العنوان

    قم بتعيين المستويات الضحلة والأعمق لتضمينها. الاختيار الشائع هو H2 إلى H3، مما يبقي المخطط قابلاً للقراءة دون إدراج كل قسم فرعي.

  3. اختر نمط القائمة

    قم بالتبديل بين قائمة نقطية أو مرقمة، وقم بتبديل روابط التثبيت أو إيقاف تشغيلها، وحدد مسافة بادئة ثنائية أو رباعية المسافات أو علامة تبويب.

  4. انسخ جدول المحتويات

    انسخ Markdown الذي تم إنشاؤه والصقه بالقرب من الجزء العلوي من المستند. يرتبط كل إدخال بمرساة العنوان المطابقة.

الميزات الرئيسية

  • المراسي المتوافقة مع GitHub

    Slugs يطابق المعرفات التي يعرضها GitHub، بما في ذلك اللواحق الرقمية للعناوين المكررة، بحيث يتم حل كل رابط بشكل صحيح.

  • تصفية المستوى

    قم بتضمين مستويات العناوين التي تريدها فقط. يتم قياس التعشيش من العنوان الأقل عمقًا، لذا تظل القائمة التي تبدأ عند H2 متدفقة إلى اليسار.

  • أمر أو غير أمر

    قم بإخراج قائمة نقطية أو قائمة مرقمة تحتوي على عدادات لكل مستوى، مع روابط ربط اختيارية ومسافة بادئة قابلة للتكوين.

  • علم بكتلة التعليمات البرمجية

    يتم تجاهل العناوين المكتوبة داخل كتل التعليمات البرمجية المسيجة، لذلك لا تتسرب مقتطفات الأمثلة أبدًا إلى المخطط التفصيلي الخاص بك.

Frequently Asked Questions

جدول محتويات Markdown عبارة عن قائمة من الروابط التي تشير إلى مثبتات العناوين داخل نفس الصفحة. يتم إعطاء كل عنوان في مستند Markdown معرفًا تلقائيًا، وينتقل إليه رابط مكتوب كـ [Section](#section). تقرأ هذه الأداة عناوينك، وتبني أدوات التثبيت المطابقة، وتجمع القائمة المتداخلة لك.

Comments

0 comments

0/2000 characters

No comments yet. Be the first to share your thoughts!

markdown table of contentsmarkdown toc generatorgenerate tocmarkdown toctable of contents generatorgithub anchor linksreadme tocheading linksmarkdown outline