Files

Use file links when a reader needs a real artifact: a CSV template, PDF checklist, OpenAPI file, screenshot, or configuration example. Keep files explicit, named, and close to the setup step that uses them.

File link

Download the site documentation index when an agent or tool needs a complete public docs map.

Download the <a href="/llms.txt" download>site documentation index</a>.

File card

<CardGroup cols={1} gap="sm" variant="layer">
  <Card variant="layer" title="Documentation index" icon="file-text" href="/llms.txt" description="Use llms.txt as a machine-readable index." />
  <Card variant="layer" title="Sitemap" icon="globe" href="/sitemap-index.xml" description="Use the sitemap index when validating routes." />
</CardGroup>

File structure

Use Tree when the file itself is not the artifact but the placement matters.

<Tree>
  <TreeFolder name="content/docs">
    <TreeFile name="quickstart.mdx" />
    <TreeFolder name="components">
      <TreeFile name="files.mdx" />
    </TreeFolder>
  </TreeFolder>
</Tree>

Authoring rules

File rules

Name the artifactlink text

Link text should identify the file or artifact. Avoid vague labels such as click here.

Use download intentionallyattribute

Add download when the user should save the file rather than navigate to it.

Prefer cards for important artifactsCard

Use a full-width icon card when a file is a meaningful next step.

Use snippets for pathsSnippet

Use Snippet for exact filenames, directories, headers, or environment variables mentioned inline.

Properties

Related