> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/latex/ar/qaadh-almarfh/166-writing-markdown-in-latex-documents.md).

# كتابة Markdown في مستندات LaTeX

## مقدمة

لاستخدام Markdown في مستند LaTeX، تحتاج إلى تحميل [`ماركداون` الحزمة](https://www.ctan.org/pkg/markdown) في مقدمة المستند:

```latex
\usepackage[settings]{markdown}
```

حيث `[settings]` هي *اختيارية* مجموعة من المعاملات تُستخدم لتكوين أو تمكين ميزات محددة للحزمة. راجع `ماركداون` الحزمة [الوثائق](https://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/generic/markdown/markdown.html) لـ [وصف معاملات الحزمة (الخيارات)](https://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/generic/markdown/markdown.html#options).

ستستعرض هذه المقالة بإيجاز كلا من *السطرية* Markdown — المكتوب داخل مستندك — واستيراد *خارجي* Markdown الموجود في ملف نصي.

* **ملاحظة إرشادية**بوجه عام، ينبغي التعامل مع استخدام Markdown داخل مستند LaTeX كخيار مكمل ومريح لكتابة بعض عناصر محتوى مستندك، لا كصياغة بديلة لتحل محل LaTeX بالكامل.

## استخدام ملفات Markdown الخارجية

استخدم الأمر

```latex
\markdownInput{filename}
```

لتضمين ملف Markdown `filename`.

يدرج المثال التالي ملفًا يُسمى `example.md`. استخدم الرابط أسفل القوائم البرمجية لفتحها كمشروع Overleaf:

**`main.tex`**

```latex
\documentclass{article}
\title{Using the markdown package}
\usepackage[smartEllipses]{markdown}
\begin{document}

\markdownInput{example.md}

\end{document}
```

**`example.md`**

```latex
%% example.md

# أنا ملف Markdown.

ويمكنني القيام بـ *التأكيد*.
## مع عناوين فرعية

> الاقتباسات الكتلية هي
> مكتوبة بهذه الطريقة.
>
> ويمكن أن تمتد عبر عدة فقرات،
> إذا أردت ذلك.

استخدم 3 شرطات لشرطة em-dash. استخدم شرطتين لـ
النطاقات (مثلًا: "كل ذلك في الفصول 12--14").
ستتحول ثلاث نقاط ... إلى علامة الحذف
(بشرط أن تُدرج خيار smartEllipses
في المقدمة). تُدعَم Unicode.
```

[افتح هذه الملفات كمشروع Overleaf.](https://www.overleaf.com/docs?engine=pdflatex\&snip_name\[]=main.tex\&snip\[]=%5Cdocumentclass%7Barticle%7D%0A%5Ctitle%7BUsing+the+markdown+package%7D%0A%5Cusepackage%5BsmartEllipses%5D%7Bmarkdown%7D%0A%5Cbegin%7Bdocument%7D%0A%0A%5CmarkdownInput%7Bexample.md%7D%0A%0A%5Cend%7Bdocument%7D\&snip_name\[]=example.md\&snip\[]=%25%25+example.md%0A%0A%23+I%27m+a+markdown+file.%0A%0AAnd+I+can+do+%2Aemphasis%2A.%0A%23%23+With+sub-headers%0A%0A%3E+Block+quotes+are%0A%3E+written+like+so.%0A%3E%0A%3E+They+can+span+multiple+paragraphs%2C%0A%3E+if+you+like.%0A%0AUse+3+dashes+for+an+em-dash.+Use+2+dashes+for+%0Aranges+%28ex.%2C+%22it%27s+all+in+chapters+12--14%22%29.+%0AThree+dots+...+will+be+converted+to+an+ellipsis+%0A%28provided+you+include+the+smartEllipses+option+%0Ain+your+preamble%29.+Unicode+is+supported.\&main_document=main.tex)

ينتج هذا المثال المخرجات التالية:

![صورة تُظهر الناتج من حزمة markdown](/files/90ef418553da0d8ad374c3623f7452303728b9bd)

## استخدام Markdown داخل السطر

استخدم `ماركداون` البيئة:

```latex
\begin{markdown}
...يأتي Markdown الخاص بك
هنا...
\end{markdown}
```

للكتابة باستخدام Markdown داخل السطر، كما يوضح المثال التالي:

```latex
\documentclass{article}
\usepackage[hashEnumerators,smartEllipses]{markdown}
\begin{document}

استخدام Markdown داخل السطر:

\begin{markdown}
عنوان h1
============

تُفصل الفقرات بسطر فارغ.

الفقرة الثانية. *مائل*، **عريض**، و`monospace`. القوائم المرقمة
تبدو مثل:

* هذا
* ذاك
* الآخر

> الاقتباسات الكتلية هي
> مكتوبة بهذه الطريقة.
>
> ويمكن أن تمتد عبر عدة فقرات،
> إذا أردت ذلك.

عنوان h2
------------

إليك قائمة مرقمة (استخدم خيار `hashEnumerators` إذا أردت استخدام الهاشات):

#. العنصر الأول
#. العنصر الثاني
#. العنصر الثالث

\end{markdown}
\end{document}
```

[افتح هذا المثال في Overleaf.](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Using+markdown\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BhashEnumerators%2CsmartEllipses%5D%7Bmarkdown%7D%0A%5Cbegin%7Bdocument%7D%0A%0AUsing+inline+markdown%3A%0A%0A%5Cbegin%7Bmarkdown%7D%0AAn+h1+header%0A%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%0A%0AParagraphs+are+separated+by+a+blank+line.+%0A%0A2nd+paragraph.+%2AItalic%2A%2C+%2A%2Abold%2A%2A%2C+and+%60monospace%60.+Itemized+lists%0Alook+like%3A%0A%0A%2A+this+one%0A%2A+that+one%0A%2A+the+other+one%0A%0A%3E+Block+quotes+are%0A%3E+written+like+so.%0A%3E%0A%3E+They+can+span+multiple+paragraphs%2C%0A%3E+if+you+like.%0A%0AAn+h2+header%0A------------%0A%0AHere%27s+a+numbered+list+%28use+%60hashEnumerators%60+option+if+you+want+to+use+hashes%29%3A%0A%0A%23.+first+item%0A%23.+second+item%0A%23.+third+item%0A%0A%5Cend%7Bmarkdown%7D%0A%5Cend%7Bdocument%7D)

ينتج هذا المثال المخرجات التالية:

![مثال على تنضيد Markdown داخل Overleaf](/files/a0e81ac5033394db717353b474c36fb618e646c0)

## ميزات وخيارات حزمة Markdown

هنا سنستعرض بعضًا من [الميزات والخيارات](https://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/generic/markdown/markdown.html) المقدمة بواسطة `ماركداون` الحزمة.

### إدراج الشفرة في Markdown

هناك آليتان لعرض مقتطفات من الشفرة (كتل الشفرة) داخل Markdown:

* بإزاحة كل سطر في الكتلة بمقدار أربع مسافات على الأقل أو بعلامة جدولة واحدة، أو
* باستخدام ما يُسمى [كتل الشفرة المحاطة](#using-fenced-code-blocks)

#### استخدام الإزاحة لعرض كتل الشفرة

يستخدم المثال التالي 4 أحرف مسافة، أو أكثر، في بداية كل سطر من الشفرة — بعض الأسطر تستخدم 6 أو 8 أو 10 أحرف مسافة تبعًا لحجم الإزاحة المطلوبة:

```latex
\documentclass{article}
\usepackage{markdown}
\begin{document}
إليك بعض مقاطع الشفرة المزاحة بما لا يقل عن 4 أحرف مسافة.
\vspace{6mm}

\begin{markdown}

إليك مقطعًا من C:

    /* دعني أكرّر ... */

    int i;
    for(i=0; i<10; i++)
    {
      do-something(i)
    }

وهنا بعض HTML:

    <html>
      <head>
        <title>عنوان الصفحة</title>
      </head>
      <body>
        <h1>هذه عنوان</h1>
          <p>هذه فقرة.</p>
      </body>
    </html>

\end{markdown}
\end{document}
```

[افتح هذا المثال في Overleaf.](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Using+markdown+code+snippets\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bmarkdown%7D%0A%5Cbegin%7Bdocument%7D%0AHere+are+some+code+fragments+indented+by+at+least+4+space+characters.%0A%5Cvspace%7B6mm%7D%0A%0A%5Cbegin%7Bmarkdown%7D%0A%0AHere+is+a+fragment+of+C%3A%0A%0A++++%2F%2A+Let+me+iterate+...+%2A%2F%0A%0A++++int+i%3B%0A++++for%28i%3D0%3B+i%3C10%3B+i%2B%2B%29%0A++++%7B%0A++++++do-something%28i%29%0A++++%7D%0A%0AHere+is+some+HTML%3A%0A%0A++++%3Chtml%3E%0A++++++%3Chead%3E%0A++++++++%3Ctitle%3EPage+Title%3C%2Ftitle%3E%0A++++++%3C%2Fhead%3E%0A++++++%3Cbody%3E%0A++++++++%3Ch1%3EThis+is+a+Heading%3C%2Fh1%3E%0A++++++++++%3Cp%3EThis+is+a+paragraph.%3C%2Fp%3E%0A++++++%3C%2Fbody%3E%0A++++%3C%2Fhtml%3E%0A%0A%5Cend%7Bmarkdown%7D%0A%5Cend%7Bdocument%7D)

ينتج هذا المثال المخرجات التالية:

![مثال على تنضيد الشفرة عبر Markdown](/files/721aeb83c69fdd2b50e33245269eda7085c2c98a)

#### استخدام كتل الشفرة المحاطة

تُنشأ كتلة الشفرة المحاطة بكتابة إما

* ثلاث علامات backtick (` ``` `)، أو
* ثلاث علامات tilde (`~~~`)

في الأسطر قبل كتلة الشفرة وبعدها. باستخدام هذه الطريقة لن تحتاج إلى إزاحة أي أسطر، لكنك تحتاج إلى استخدام خيار `fencedCode` في المقدمة:

```latex
\usepackage[fencedCode]{markdown}
```

إليك مثالًا ينشئ كتل شفرة محاطة باستخدام 3 علامات backtick (` ``` `):

````latex
\documentclass{article}
\usepackage[fencedCode]{markdown}
\begin{document}
\begin{markdown}

```
if (a > 3) {
    moveShip(5 * gravity, DOWN);
}
```

```
    <html>
      <head>
        <title>عنوان الصفحة</title>
      </head>
      <body>
        <h1>هذه عنوان</h1>
          <p>هذه فقرة.</p>
      </body>
    </html>
```
\end{markdown}
\end{document}
````

[افتح هذا المثال في Overleaf.](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Using+markdown+fenced+code+blocks\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BfencedCode%5D%7Bmarkdown%7D%0A%5Cbegin%7Bdocument%7D%0A%5Cbegin%7Bmarkdown%7D%0A%0A%60%60%60%0Aif+%28a+%3E+3%29+%7B%0A++++moveShip%285+%2A+gravity%2C+DOWN%29%3B%0A%7D%0A%60%60%60%0A%0A%60%60%60%0A++++%3Chtml%3E%0A++++++%3Chead%3E%0A++++++++%3Ctitle%3EPage+Title%3C%2Ftitle%3E%0A++++++%3C%2Fhead%3E%0A++++++%3Cbody%3E%0A++++++++%3Ch1%3EThis+is+a+Heading%3C%2Fh1%3E%0A++++++++++%3Cp%3EThis+is+a+paragraph.%3C%2Fp%3E%0A++++++%3C%2Fbody%3E%0A++++%3C%2Fhtml%3E%0A%60%60%60%0A%5Cend%7Bmarkdown%7D%0A%5Cend%7Bdocument%7D)

ينتج هذا المثال المخرجات التالية:

![استخدام كتل الشفرة المحاطة مع حزمة Markdown الخاصة بـ LaTeX](/files/4cc391491af8fd6f59c6ec369385f9adfc02a209)

#### تظليل الصياغة

تدعم كتل الشفرة المحاطة تظليل الصياغة من خلال كتابة اسم اللغة بعد المجموعة الأولى من علامات backtick (`` ` ``). على سبيل المثال، تُعرَّف الكتلة التالية على أنها Javascript بكتابة المجموعة الأولى من علامات backtick على النحو ` ``` js `:

````latex
``` js
if (a > 3) {
    moveShip(5 * gravity, DOWN);
}
```
````

أما بالنسبة إلى LaTeX، فيمكن استخدام `minted` الحزمة لتظليل الصياغة، كما يوضح المثال التالي الذي يحتوي على بعض Javascript (` ``` js `) وHTML (` ``` html `):

````latex
\documentclass{article}
\usepackage{minted}
\usepackage[fencedCode]{markdown}
\begin{document}
\begin{markdown}

``` js
if (a > 3) {
    moveShip(5 * gravity, DOWN);
}
```

``` html
    <html>
      <head>
        <title>عنوان الصفحة</title>
      </head>
      <body>
        <h1>هذه عنوان</h1>
          <p>هذه فقرة.</p>
      </body>
    </html>
```
\end{markdown}
\end{document}
````

[افتح هذا المثال في Overleaf.](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Using+markdown+fenced+code+blocks\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bminted%7D%0A%5Cusepackage%5BfencedCode%5D%7Bmarkdown%7D%0A%5Cbegin%7Bdocument%7D%0A%5Cbegin%7Bmarkdown%7D%0A%0A%60%60%60+js%0Aif+%28a+%3E+3%29+%7B%0A++++moveShip%285+%2A+gravity%2C+DOWN%29%3B%0A%7D%0A%60%60%60%0A%0A%60%60%60+html%0A++++%3Chtml%3E%0A++++++%3Chead%3E%0A++++++++%3Ctitle%3EPage+Title%3C%2Ftitle%3E%0A++++++%3C%2Fhead%3E%0A++++++%3Cbody%3E%0A++++++++%3Ch1%3EThis+is+a+Heading%3C%2Fh1%3E%0A++++++++++%3Cp%3EThis+is+a+paragraph.%3C%2Fp%3E%0A++++++%3C%2Fbody%3E%0A++++%3C%2Fhtml%3E%0A%60%60%60%0A%5Cend%7Bmarkdown%7D%0A%5Cend%7Bdocument%7D)

ينتج هذا المثال المخرجات التالية:

![تظليل الصياغة باستخدام minted وMarkdown](/files/b8d18e1862e3be7a71e7d5781d2a09329effc94d)

### القوائم

الأمثلة السابقة [تُظهر إنشاء قوائم غير مرتبة](#using-inline-markdown) في Markdown باستخدام `*` الحرف. ويمكن إنشاء القوائم المرتبة باستخدام `#` الحرف إذا كان `hashEnumerators` الخيار قد تم تحديده:

```latex
\usepackage[hashEnumerators]{markdown}
```

من الممكن أيضًا إنشاء قوائم متداخلة، كما يوضح المثال التالي:

```latex
\documentclass{article}
\usepackage[hashEnumerators]{markdown}
\begin{document}
\begin{markdown}
إليك قائمة مرقمة تحتوي على قائمة متداخلة:

#. أولًا، احصل على هذه المكونات:

      * جزر
      * كرفس
      * عدس

#. اغْلِ بعض الماء.

#. أفرغ كل شيء في القدر واتبع هذه الخوارزمية:

        اعثر على ملعقة خشبية
        اكشف القدر
        حرّك
        غطِّ القدر
        وازن الملعقة الخشبية بحذر على مقبض القدر
        انتظر 10 دقائق
        اذهب إلى الخطوة الأولى (أو أطفئ الموقد عند الانتهاء)

    لا تصطدم بالملعقة الخشبية وإلا فسوف تسقط.
\end{markdown}
\end{document}
```

[افتح هذا المثال في Overleaf.](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Creating+a+nested+list+in+markdown\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BhashEnumerators%5D%7Bmarkdown%7D%0A%5Cbegin%7Bdocument%7D%0A%5Cbegin%7Bmarkdown%7D%0AHere+is+a+numbered+list+that+contains+a+nested+list%3A%0A%0A%23.+First%2C+get+these+ingredients%3A%0A%0A++++++%2A+carrots%0A++++++%2A+celery%0A++++++%2A+lentils%0A%0A%23.+Boil+some+water.%0A%0A%23.+Dump+everything+in+the+pot+and+follow+this+algorithm%3A%0A%0A++++++++find+wooden+spoon%0A++++++++uncover+pot%0A++++++++stir%0A++++++++cover+pot%0A++++++++balance+wooden+spoon+precariously+on+pot+handle%0A++++++++wait+10+minutes%0A++++++++goto+first+step+%28or+shut+off+burner+when+done%29%0A%0A++++Do+not+bump+wooden+spoon+or+it+will+fall.%0A%5Cend%7Bmarkdown%7D%0A%5Cend%7Bdocument%7D)

ينتج هذا المثال المخرجات التالية:

![إنشاء قوائم مرقمة باستخدام حزمة Markdown الخاصة بـ LaTeX](/files/18805a6869ca227afa9684ba2bd94e13ad6db341)

### إدراج LaTeX داخل Markdown

إذا فعّلت خيار `الهجين` فيمكنك مزج شيفرة LaTeX داخل Markdown!

```latex
\documentclass{article}
\usepackage[hybrid]{markdown}
\begin{document}

\begin{markdown}
يمكن إنشاء المعادلات الرياضية داخل السطر هكذا: $\omega = d\phi / dt$.
يمكن كتابة الرياضيات المعروضة كما يلي:

\begin{equation}
I = \int \rho R^{2} dV
\end{equation}

\end{markdown}
\end{document}
```

[افتح هذا المثال في Overleaf.](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Using+LaTeX+code+in+markdown\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5Bhybrid%5D%7Bmarkdown%7D%0A%5Cbegin%7Bdocument%7D%0A%0A%5Cbegin%7Bmarkdown%7D%0AInline+math+equations+can+be+created+like+this%3A+%24%5Comega+%3D+d%5Cphi+%2F+dt%24.+%0ADisplay+math+can+be+written+as%3A%0A%0A%5Cbegin%7Bequation%7D%0AI+%3D+%5Cint+%5Crho+R%5E%7B2%7D+dV%0A%5Cend%7Bequation%7D%0A%0A%5Cend%7Bmarkdown%7D%0A%5Cend%7Bdocument%7D)

ينتج هذا المثال المخرجات التالية:

![استخدام شيفرة LaTeX في Markdown](/files/3fa19a8235424a7744c7550c95518a85ff4b441e)

### إدراج الصور

* **ملاحظة**: يستخدم المثال التالي ملف رسومات (`example-image.pdf`) الموفَّر من قِبل `mwe` الحزمة. تُوزَّع ملفات الرسومات هذه مع TeX Live وبالتالي تكون مخزّنة على خوادم Overleaf، مما يجعلها متاحة كعناصر نائبة للصور، مثل المثال أدناه.

يمكن تضمين الصور في Markdown بكتابة ترميز بالشكل التالي:

```latex
![نص بديل](اسم-الملف "تعليق الصورة")
```

نأمل أن تكون أسماء المعاملات `النص البديل`, `اسم-الملف` و `"تعليق الصورة"` تصف ما تفعله. إليك مثالًا لتوضيحها:

```latex
\documentclass{article}
\usepackage[hybrid]{markdown}
% توفر حزمة mwe صورًا نموذجية. تحميلها
% ليس ضروريًا لأن تلك الصور موجودة ضمن مسار البحث الخاص بـ LaTeX.
% هنا، نقوم بتحميلها للوضوح في هذا المثال.
\usepackage{mwe}
\begin{document}
\begin{markdown}
يوضح هذا المثال كيفية استيراد ملف رسومات. نحن هنا نستخدم
صورة نموذجية مقدمة من حزمة `mwe`.

% استخدم \setkeys{Gin} إذا احتجت إلى تغيير حجم عرض الصورة

\setkeys{Gin}{width=.5\linewidth}
![هذا نص بديل لوصف صورتي.](example-image.jpg "صورة نموذجية مقدمة من حزمة \texttt{mwe}.")
\end{markdown}
\end{document}
```

[افتح هذا المثال على Overleaf.](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Using+images+in+markdown\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5Bhybrid%5D%7Bmarkdown%7D%0A%25+The+mwe+package+provides+example+images.+Loading+it+is%0A%25+not+essential+because+those+images+are+in+LaTeX%27s+search+path.+%0A%25+Here%2C+we+load+it+for+clarity+in+this+example.%0A%5Cusepackage%7Bmwe%7D%0A%5Cbegin%7Bdocument%7D%0A%5Cbegin%7Bmarkdown%7D%0AThis+example+shows+how+to+import+a+graphics+file.+Here+we+are+using+an%0Aexample+image+provided+by+the+%60mwe%60+package.%0A%0A%25+Use+%5Csetkeys%7BGin%7D+if+you+need+to+change+an+image%27s+display+size%0A%0A%5Csetkeys%7BGin%7D%7Bwidth%3D.5%5Clinewidth%7D%0A%21%5BThis+is+alt+text+to+describe+my+image.%5D%28example-image.jpg+%22An+example+image+provided+by+the+%5Ctexttt%7Bmwe%7D+package.%22%29%0A%5Cend%7Bmarkdown%7D%0A%5Cend%7Bdocument%7D)

ينتج هذا المثال المخرجات التالية:

![إظهار كيفية استيراد الصور في Markdown](/files/d841d4e085eaeb23572117e0f1571f569a16f6b2)

#### ملاحظة حول عرض الصورة

مثل معظم الحزم، `ماركداون` يقوم بتحميل حزم أخرى، بما في ذلك [`keyval`](https://ctan.org/pkg/keyval?lang=en) و [`graphicx`](https://ctan.org/pkg/graphicx?lang=en)، للاستفادة من الأوامر والميزات التي توفرها. هنا، يتم ضبط عرض الصورة باستخدام الأمر `\setkeys` ، الذي توفره `keyvals`. `Gin` هي "عائلة" من المفاتيح يعرّفها `graphicx` الحزمة.

* **ملاحظة**نظرًا إلى أن أمر LaTeX، هنا `\setkeys`، يُستخدم *داخل* موقع `ماركداون` بيئة، فإن `الهجين` الخيار الخاص بحزمة markdown مطلوب.

## قراءة إضافية

نشرت Overleaf مقالات أخرى حول استخدام Markdown:

* [كيفية الكتابة بـ Markdown على Overleaf](/latex/ar/mqalat-mtamqh/30-how-to-write-in-markdown-on-overleaf.md)
* [Markdown إلى LaTeX بأسلوب](/latex/ar/mqalat-mtamqh/32-markdown-into-latex-with-style.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://overleaf-pro.ayaka.space/latex/ar/qaadh-almarfh/166-writing-markdown-in-latex-documents.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
