> ## Documentation Index
> Fetch the complete documentation index at: https://vuemail.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Writing docs

We use [Mintlify](https://mintlify.com/) for our documentation.

To preview the docs, you just need to run:

```sh apps/docs theme={null}
pnpm dev
```

Before opening a pull request, check that every link points to an existing page:

```sh apps/docs theme={null}
npx mintlify broken-links
```

Check out [Mintlify's development guide](https://mintlify.com/docs/development)
for a few more interesting development tools.

## Components

Mintlify uses `mdx` to allow us to write docs in a composable ways. Because of
`mdx`, we can build [our own
components](https://mintlify.com/docs/reusable-snippets#reusable-components)
but it's always best to use the components Mintlify already provides us. Before writing down a new component, check their [full list of components](https://mintlify.com/docs/content/components).

## Code samples

Write the code samples for Vue: emails as single file components with `<script setup lang="ts">`, and
anything else as TypeScript. Make sure they work with the current API of the packages.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.