# AgentFriendlyOptions

<pre class="nacara-api__signature"><code><span class="tok-keyword">type</span> <span class="tok-type">AgentFriendlyOptions</span> <span class="tok-operator">=</span>
    <span class="tok-punctuation">{</span>
        <a class="tok-property" href="#formats">Formats</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span>
        <a class="tok-property" href="#markdowncopies">MarkdownCopies</a><span class="tok-punctuation">:</span> <span class="tok-type">bool</span>
        <a class="tok-property" href="#llmstxt">LlmsTxt</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">option</span>
        <a class="tok-property" href="#llmsfulltxt">LlmsFullTxt</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">option</span>
        <a class="tok-property" href="#alternatelink">AlternateLink</a><span class="tok-punctuation">:</span> <span class="tok-type">bool</span>
        <a class="tok-property" href="#summary">Summary</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">option</span>
        <a class="tok-property" href="#details">Details</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">option</span>
        <a class="tok-property" href="#descriptionkeys">DescriptionKeys</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span>
        <a class="tok-property" href="#section">Section</a><span class="tok-punctuation">:</span> <span class="tok-type">Page</span> <span class="tok-operator">-&gt;</span> <span class="tok-type">string</span>
        <a class="tok-property" href="#excludecollections">ExcludeCollections</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span>
    <span class="tok-punctuation">}</span></code></pre>

| | |
|---|---|
| Assembly | `Partas.Nacara.Plugins.AgentFriendly` |

Options of the agent-friendly plugin.

## Fields

<div class="nacara-api__entry" id="formats">
<a class="nacara-api__anchor"
                           href="#formats"
                           aria-label="Link to Formats"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">Formats</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span></code></pre>
</summary>
<div class="nacara-api__body">

Source formats whose pages are published as markdown too, lowercase and dotted.

A page's body is written as it was authored, so only a format that is already
markdown reads well that way. Defaults to `[ ".md" ]`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="markdowncopies">
<a class="nacara-api__anchor"
                           href="#markdowncopies"
                           aria-label="Link to MarkdownCopies"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">MarkdownCopies</span><span class="tok-punctuation">:</span> <span class="tok-type">bool</span></code></pre>
</summary>
<div class="nacara-api__body">

Write a markdown copy of each page beside its html.

`/guide/setup/` is copied to `/guide/setup.md`, the url an agent
guesses. Defaults to `true`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="llmstxt">
<a class="nacara-api__anchor"
                           href="#llmstxt"
                           aria-label="Link to LlmsTxt"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">LlmsTxt</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">option</span></code></pre>
</summary>
<div class="nacara-api__body">

Where the `llms.txt` index is written, or `None` for none.

Defaults to `Some "llms.txt"`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="llmsfulltxt">
<a class="nacara-api__anchor"
                           href="#llmsfulltxt"
                           aria-label="Link to LlmsFullTxt"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">LlmsFullTxt</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">option</span></code></pre>
</summary>
<div class="nacara-api__body">

Where every markdown page is written as one file, or `None` for none.

Defaults to `Some "llms-full.txt"`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="alternatelink">
<a class="nacara-api__anchor"
                           href="#alternatelink"
                           aria-label="Link to AlternateLink"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">AlternateLink</span><span class="tok-punctuation">:</span> <span class="tok-type">bool</span></code></pre>
</summary>
<div class="nacara-api__body">

Point each page's head at its markdown copy with
`<link rel="alternate" type="text/markdown">`.

Defaults to `true`. Needs `MarkdownCopies`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="summary">
<a class="nacara-api__anchor"
                           href="#summary"
                           aria-label="Link to Summary"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">Summary</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">option</span></code></pre>
</summary>
<div class="nacara-api__body">

The line quoted under the title of `llms.txt`.

Defaults to `None`, which uses the site's description.


</div>
</details>
</div>

<div class="nacara-api__entry" id="details">
<a class="nacara-api__anchor"
                           href="#details"
                           aria-label="Link to Details"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">Details</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">option</span></code></pre>
</summary>
<div class="nacara-api__body">

Markdown placed after the summary in `llms.txt`: what an agent should
know before it reads any page.

Defaults to `None`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="descriptionkeys">
<a class="nacara-api__anchor"
                           href="#descriptionkeys"
                           aria-label="Link to DescriptionKeys"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">DescriptionKeys</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span></code></pre>
</summary>
<div class="nacara-api__body">

The front matter keys a page's description is read from, first match wins.

Defaults to `[ "description"; "summary" ]`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="section">
<a class="nacara-api__anchor"
                           href="#section"
                           aria-label="Link to Section"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">Section</span><span class="tok-punctuation">:</span> <span class="tok-type">Page</span> <span class="tok-operator">-&gt;</span> <span class="tok-type">string</span></code></pre>
</summary>
<div class="nacara-api__body">

The heading a page is listed under in `llms.txt`.

Defaults to the first segment of its route, title-cased, and `Pages`
for a page at the top of the site.


</div>
</details>
</div>

<div class="nacara-api__entry" id="excludecollections">
<a class="nacara-api__anchor"
                           href="#excludecollections"
                           aria-label="Link to ExcludeCollections"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">ExcludeCollections</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span></code></pre>
</summary>
<div class="nacara-api__body">

Collections to leave out of everything.

Defaults to `[]`.


</div>
</details>
</div>
