Skip to content

mixpeek/docs

Repository files navigation

Mixpeek Documentation

This repository contains the Mintlify documentation for Mixpeek.

Installation

Install the Mintlify CLI globally:

npm i -g mintlify

Note: Requires Node.js v19 or higher. If using nvm:

nvm use 20.19.3

Development

Run the local development server:

mintlify dev

The documentation will be available at http://localhost:3000 by default. Use --port to specify a custom port:

mintlify dev --port 3333

Generating API Reference from OpenAPI

To generate API reference documentation from the OpenAPI specification:

npx @mintlify/scraping@latest openapi-file api-reference/openapi.json

This will automatically create API reference pages in the api-reference/ directory based on your OpenAPI spec.

Additional Commands

  • mintlify broken-links - Check for broken internal links
  • mintlify openapi-check api-reference/openapi.json - Validate your OpenAPI file
  • mintlify update - Update to the latest Mintlify CLI version

About

mixpeek documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •