Mastra Documentation

Welcome to the home of Mastra's documentation! Everything you see on mastra.ai/docs is sourced from this directory.

Want to contribute? Check out our contribution guidelines for details on how to get started.

Here's a quick start to run the docs locally

Optional: Linting

To lint markdown files according to remark rules (e.g. enforcing consistent heading levels, list markers, etc.), you can use remark:

bash

pnpm run lint:remark

Vale is a syntax-aware linter for prose that can help enforce style and grammar rules. We use it to maintain consistency across our documentation.

Run the Vale download script to fetch a binary:
bash
```
pnpm run vale:download
```
Install mdx2vast globally, which is a dependency for Vale to lint MDX files:
bash
```
npm install -g mdx2vast
```
Then you can run the Vale linter:
bash
```
pnpm run lint:vale
```