> ## Documentation Index
> Fetch the complete documentation index at: https://mint-tsdocs.saulo.engineer/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install mint-tsdocs in your TypeScript project

export const RightArrow = ({children}) => <div>
    <span style={{
  position: 'absolute',
  top: 'calc(50% - 12px)',
  right: 20,
  opacity: .5
}}>
      <Icon icon="chevron-right" size={24} />
    </span>
    {children}
  </div>;

## No Installation Required!

You can use mint-tsdocs without installing it:

```bash theme={null}
npx mint-tsdocs
```

That's it! All dependencies are bundled.

## Optional: Install Locally

Want faster execution or version locking?

<CodeGroup>
  ```bash npm theme={null}
  npm install -D mint-tsdocs
  ```

  ```bash bun theme={null}
  bun add -D mint-tsdocs
  ```

  ```bash yarn theme={null}
  yarn add -D mint-tsdocs
  ```

  ```bash pnpm theme={null}
  pnpm add -D mint-tsdocs
  ```
</CodeGroup>

### Or Globally

<CodeGroup>
  ```bash npm theme={null}
  npm install -g mint-tsdocs
  ```

  ```bash bun theme={null}
  bun add -g mint-tsdocs
  ```

  ```bash yarn theme={null}
  yarn add -g mint-tsdocs
  ```

  ```bash pnpm theme={null}
  pnpm add -g mint-tsdocs
  ```
</CodeGroup>

Then run without npx:

```bash theme={null}
mint-tsdocs
```

<AccordionGroup>
  <Accordion title="Why install locally or globally?" icon="circle-question">
    **Benefits:**

    * Faster execution (no download)
    * Version pinned in package.json
    * Works offline
    * Slightly cleaner npm scripts

    **Downsides:**

    * Adds to node\_modules size
    * Need to update manually
  </Accordion>

  <Accordion title="Why use npx?" icon="bolt">
    **Benefits:**

    * Always latest version
    * No node\_modules bloat
    * Works in any project instantly
    * No installation step

    **Downsides:**

    * First run downloads (cached after)
    * Requires internet connection
  </Accordion>
</AccordionGroup>

## Requirements

* Node.js 18 or higher
* TypeScript project with `declaration: true` in `tsconfig.json`

## Next Steps

<Card horizontal title="Quick Start" icon="rocket" href="/quickstart">
  <RightArrow>Generate your first documentation</RightArrow>
</Card>