> 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/tr/bilgi-bankasi/166-writing-markdown-in-latex-documents.md).

# LaTeX belgelerinde Markdown yazma

## Giriş

Bir LaTeX belgesinde markdown kullanmak için şunu yüklemeniz gerekir: [`markdown` paketini](https://www.ctan.org/pkg/markdown) belgenizin önsözünde:

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

burada `[ayarlar]` bir *isteğe bağlı* belirli paket özelliklerini yapılandırmak veya etkinleştirmek için kullanılan bir parametreler kümesidir. Şuraya bakın: `markdown` paketini [belgelere](https://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/generic/markdown/markdown.html) için [paket parametrelerinin (seçeneklerinin) açıklaması](https://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/generic/markdown/markdown.html#options).

Bu makale kısaca her ikisini de gözden geçirecektir: *satır içi* belgenizin içinde yazılan markdown'ı ve içe aktarmayı *harici* bir metin dosyasında bulunan markdown'ı.

* **Uyarı notu**: Genel olarak, bir LaTeX belgesi içinde markdown kullanımı, belgenizin içeriğinin bazı öğelerini oluşturmak için tamamlayıcı ve kullanışlı bir seçenek olarak değerlendirilmelidir; LaTeX'in yerini tamamen alacak alternatif bir sözdizimi olarak değil.

## Harici markdown dosyalarını kullanma

Şu komutu kullanın:

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

markdown dosyasını dahil etmek için `dosya adı`.

Aşağıdaki örnek, adlı bir dosyayı ekler: `example.md`. Onları bir Overleaf projesi olarak açmak için kod listelerinin altındaki bağlantıyı kullanın:

**`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

# Ben bir markdown dosyasıyım.

Ve *vurgu* yapabilirim.
## Alt başlıklarla

> Alıntı blokları
> şöyle yazılır.
>
> Birden fazla paragrafı kapsayabilirler,
> isterseniz.

Bir uzun çizgi için 3 tire kullanın. Aralıklar için 2 tire kullanın
aralıklar (örn., "hepsi 12--14. bölümlerde").
Üç nokta ... bir üç nokta işaretine dönüştürülecektir
(smartEllipses seçeneğini eklemeniz koşuluyla
önsözünüzde). Unicode desteklenir.
```

[Bu dosyaları bir Overleaf projesi olarak açın.](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)

Bu örnek aşağıdaki çıktıyı üretir:

![markdown paketinin çıktısını gösteren grafik](/files/5a74f4d87824aaa38c697f91c2543860091dddbe)

## Satır içi markdown kullanma

Şunu kullanın `markdown` ortamını kullanmanız gerekir:

```latex
\begin{markdown}
...markdown içeriğiniz
buraya gelir...
\end{markdown}
```

satır içi markdown yazmak için, aşağıdaki örnekte gösterildiği gibi:

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

Satır içi markdown kullanımı:

\begin{markdown}
Bir h1 başlığı
============

Paragraflar boş bir satırla ayrılır.

2. paragraf. *İtalik*, **kalın** ve `tek aralıklı`. Madde işaretli listeler
şöyle görünür:

* bu
* şu
* öteki

> Alıntı blokları
> şöyle yazılır.
>
> Birden fazla paragrafı kapsayabilirler,
> isterseniz.

Bir h2 başlığı
------------

İşte numaralı bir liste (`hashEnumerators` seçeneğini kullanmak istiyorsanız kare işaretlerini kullanın):

#. ilk öğe
#. ikinci öğe
#. üçüncü öğe

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

[Bu örneği Overleaf'te açın.](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)

Bu örnek aşağıdaki çıktıyı üretir:

![Overleaf'te dizgilenmiş satır içi markdown örneği](/files/067369d865f04a646831f6b3484d4807a6c473ec)

## Markdown paketinin özellikleri ve seçenekleri

Burada şunlardan birkaçını inceleyeceğiz [özellikler ve seçenekler](https://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/generic/markdown/markdown.html) tarafından sağlanan `markdown` paketi.

### Markdown'a kod dahil etme

Markdown içinde kod parçacıklarını (kod blokları) görüntülemek için iki mekanizma vardır:

* bloğun her satırını en az dört boşluk veya bir sekme ile girintilemek ya da
* sözde [sınırlayıcı kod blokları](#using-fenced-code-blocks)

#### Kod bloklarını görüntülemek için girinti kullanma

Aşağıdaki örnek, kodun her satırının başında 4 veya daha fazla boşluk karakteri kullanır—bazı satırlar, gereken girinti miktarına bağlı olarak 6, 8 veya 10 boşluk karakteri kullanır:

```latex
\documentclass{article}
\usepackage{markdown}
\begin{document}
İşte en az 4 boşluk karakteriyle girintilenmiş bazı kod parçaları.
\vspace{6mm}

\begin{markdown}

İşte bir C parçası:

    /* Let me iterate ... */

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

İşte biraz HTML:

    <html>
      <head>
        <title>Page Title</title>
      </head>
      <body>
        <h1>This is a Heading</h1>
          <p>This is a paragraph.</p>
      </body>
    </html>

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

[Bu örneği Overleaf'te açın.](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)

Bu örnek aşağıdaki çıktıyı üretir:

![Markdown aracılığıyla kod dizgileme örneği](/files/939912446f92d482bb2dddc41b2905bae2682c8b)

#### Sınırlayıcı kod bloklarını kullanma

Bir sınırlayıcı kod bloğu, şu şekilde yazılarak oluşturulur:

* üç ters tırnak (` ``` `), ya da
* üç tilda (`~~~`)

kod bloğundan önceki ve sonraki satırlarda. Bu yöntemi kullanarak hiçbir satırı girintilemek zorunda kalmazsınız, ancak şunu kullanmanız gerekir: `fencedCode` önsözünüzdeki seçenek:

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

İşte 3 ters tırnak kullanarak sınırlayıcı kod blokları oluşturan bir örnek (` ``` `):

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

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

```
    <html>
      <head>
        <title>Page Title</title>
      </head>
      <body>
        <h1>This is a Heading</h1>
          <p>This is a paragraph.</p>
      </body>
    </html>
```
\end{markdown}
\end{document}
````

[Bu örneği Overleaf'te açın.](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)

Bu örnek aşağıdaki çıktıyı üretir:

![Markdown LaTeX paketiyle sınırlayıcı kod blokları kullanma](/files/b7fd458bbaae268e5c108a14d3690184c07a7f53)

#### Sözdizimi vurgulama

Sınırlayıcı kod blokları, ilk ters tırnak kümesinden sonra dil adının yazılmasıyla sözdizimi vurgulamayı destekler (`` ` ``). Örneğin, aşağıdaki blok, ilk ters tırnak kümesi şu şekilde yazılarak Javascript olarak tanımlanır: ` ``` js `:

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

LaTeX için, `minted` paket sözdizimi vurgulama için kullanılabilir; aşağıdaki örnekte gösterildiği gibi, bu örnek biraz Javascript içerir (` ``` js `) ve 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>Page Title</title>
      </head>
      <body>
        <h1>This is a Heading</h1>
          <p>This is a paragraph.</p>
      </body>
    </html>
```
\end{markdown}
\end{document}
````

[Bu örneği Overleaf'te açın.](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)

Bu örnek aşağıdaki çıktıyı üretir:

![minted ve markdown ile sözdizimi vurgulama](/files/5567ce46eef0e062f35148abbdf41a82651e27a4)

### Listeler

Önceki örnekler [sırasız listeler oluşturmayı gösterir](#using-inline-markdown) markdown içinde şu karakteri kullanarak `*` karakteri. Numaralı listeler şu karakter kullanılarak oluşturulabilir `#` karakteri eğer `hashEnumerators` seçeneği belirtilmişse:

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

Aşağıdaki örnekte gösterildiği gibi iç içe listeler oluşturmak da mümkündür:

```latex
\documentclass{article}
\usepackage[hashEnumerators]{markdown}
\begin{document}
\begin{markdown}
İşte iç içe bir liste içeren numaralı bir liste:

#. Önce, şu malzemeleri alın:

      * havuç
      * kereviz
      * mercimek

#. Biraz su kaynatın.

#. Her şeyi tencereye atın ve şu algoritmayı izleyin:

        tahta kaşığı bulun
        tencerenin kapağını açın
        karıştırın
        tencerenin kapağını kapatın
        tahta kaşığı dengesizce tencere sapının üzerine yerleştirin
        10 dakika bekleyin
        ilk adıma dönün (veya işiniz bitince ocağı kapatın)

    Tahta kaşığa çarpmayın, yoksa düşer.
\end{markdown}
\end{document}
```

[Bu örneği Overleaf'te açın.](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)

Bu örnek aşağıdaki çıktıyı üretir:

![LaTeX markdown paketi kullanarak numaralı liste oluşturma](/files/b580ca6deafec0ad6dc332fd9e5cb4bea2c32500)

### Markdown içine LaTeX dahil etme

Eğer `hybrid` seçeneğini etkinleştirirseniz Markdown içinde LaTeX kodunu karıştırabilirsiniz!

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

\begin{markdown}
Satır içi matematik denklemleri şu şekilde oluşturulabilir: $\omega = d\phi / dt$.
Gösterim matematiği şu şekilde yazılabilir:

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

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

[Bu örneği Overleaf'te açın.](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)

Bu örnek aşağıdaki çıktıyı üretir:

![Markdown içinde LaTeX kodu kullanma](/files/2953032501b74d24d1e1cac24adb6f4f7f4deb64)

### Görselleri dahil etme

* **Not**: Aşağıdaki örnek bir grafik dosyası kullanır (`example-image.pdf`) tarafından sağlanan `mwe` paketini kullanır. Bu grafik dosyaları TeX Live tarafından dağıtılır ve bu nedenle Overleaf'in sunucularında saklanır; böylece aşağıdaki örnekteki gibi görsel yer tutucuları olarak kullanılabilirler.

Aşağıdaki biçimde işaretleme yazarak görseller markdown'a dahil edilebilir:

```latex
![Bu, görselimi açıklamak için alternatif metindir.](example-image.jpg "\texttt{mwe} paketi tarafından sağlanan örnek bir görsel.")
```

Umarım parametre adları `alt-text`, `file-name` ve `"görsel başlığı"` ne işe yaradıklarını açıklar. İşte bunları göstermek için bir örnek:

```latex
\documentclass{article}
\usepackage[hybrid]{markdown}
% mwe paketi örnek görseller sağlar. Onu yüklemek
% zorunlu değildir çünkü bu görseller LaTeX'in arama yolundadır.
% Burada, bu örnekte açıklık sağlamak için yüklüyoruz.
\usepackage{mwe}
\begin{document}
\begin{markdown}
Bu örnek, bir grafik dosyasının nasıl içe aktarılacağını gösterir. Burada bir
`mwe` paketi tarafından sağlanan örnek görseli kullanıyoruz.

% Bir görselin görüntü boyutunu değiştirmeniz gerekirse \setkeys{Gin} kullanın

\setkeys{Gin}{width=.5\linewidth}
![Bu, görselimi açıklamak için alternatif metindir.](example-image.jpg "\texttt{mwe} paketi tarafından sağlanan örnek bir görsel.")
\end{markdown}
\end{document}
```

[Bu örneği Overleaf'te açın.](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)

Bu örnek aşağıdaki çıktıyı üretir:

![Markdown'da görsellerin nasıl içe aktarılacağını gösterme](/files/673b57633778a263c4227231721d5b0d1e55f0ec)

#### Görsel genişliği hakkında not

Çoğu paket gibi, `markdown` şu paketler de dahil olmak üzere başka paketleri yükler: [`keyval`](https://ctan.org/pkg/keyval?lang=en) ve [`graphicx`](https://ctan.org/pkg/graphicx?lang=en), onların sağladığı komutları ve özellikleri kullanmak için. Burada görsel genişliği şu komut kullanılarak ayarlanır: `\setkeys` komutu; bu komut şunun tarafından sağlanır: `keyvals`. `Gin` şu tarafından tanımlanan bir anahtar "ailesi"dir: `graphicx` paketi.

* **Not**: Bir LaTeX komutu olduğu için, burada `\setkeys`, kullanılır *içinde* şu `markdown` ortamı, şu `hybrid` markdown paketinin seçeneği gereklidir.

## Daha fazla okuma

Overleaf, markdown kullanımı hakkında başka makaleler de yayımladı:

* [Overleaf'te Markdown'da nasıl yazılır](/latex/tr/derinlemesine-makaleler/30-how-to-write-in-markdown-on-overleaf.md)
* [Stille Markdown'dan LaTeX'e](/latex/tr/derinlemesine-makaleler/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/tr/bilgi-bankasi/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.