# Files
Link downloadable files, static assets, and reference artifacts from Plandalf docs without breaking the reading flow.
Source: /docs/components/files
Last modified: 2026-06-20
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 <a href="/llms.txt" download>site documentation index</a> when an agent or tool needs a complete public docs map.

```mdx title="file-link.mdx"
Download the <a href="/llms.txt" download>site documentation index</a>.
```

## File card


  - [Documentation index](/llms.txt): Use llms.txt as a machine-readable index of public Plandalf docs.
  - [Sitemap](/sitemap-index.xml): Use the sitemap index when validating public route coverage.


```mdx title="file-cards.mdx"

  - [Documentation index](/llms.txt): Use llms.txt as a machine-readable index.
  - [Sitemap](/sitemap-index.xml): Use the sitemap index when validating routes.

```

## File structure

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


- content/docs/


- quickstart.mdx


- components/


- image-embeds.mdx


- files.mdx


- reusable-snippets.mdx


```mdx title="file-tree.mdx"


- content/docs/


- quickstart.mdx


- components/


- files.mdx


```

## Authoring rules


### File rules


- `Name the artifact` (link text):
    Link text should identify the file or artifact. Avoid vague labels such as `click here`.


- `Use download intentionally` (attribute):
    Add `download` when the user should save the file rather than navigate to it.


- `Prefer cards for important artifacts` (Card):
    Use a full-width icon card when a file is a meaningful next step.


- `Use snippets for paths` (Snippet):
    Use `Snippet` for exact filenames, directories, headers, or environment variables mentioned inline.


## Properties


- `href` (string; required):
  Public path or URL for the file.


- `download` (boolean | string):
  Native HTML attribute that hints the link should download.


- `target` (string):
  Use `_blank` only for external files where staying on the docs page matters.


## Related


  - [Cards](/docs/components/cards): Use for important file destinations.
  - [Tree](/docs/components/tree): Show where files live.
  - [Reusable snippets](/docs/components/reusable-snippets): Reuse exact paths and setup fragments.