Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.grigori.in/llms.txt

Use this file to discover all available pages before exploring further.

​
Document Converter API Documentation

This directory contains the complete documentation for the Document Converter API, built with Mintlify.

​
Structure

The documentation is organized into logical sections for easy navigation
docs/
├── mint.json                 # Mintlify configuration
├── introduction.mdx          # Homepage and overview
├── quickstart.mdx           # Quick start guide
├── setup.mdx                # Detailed setup instructions
├── api-reference/           # API documentation
│   ├── introduction.mdx     # API overview
│   ├── jobs.mdx            # Jobs API endpoints
│   ├── health.mdx          # Health check endpoints
│   └── errors.mdx          # Error handling guide
├── features/               # Feature documentation
│   ├── conversion.mdx      # Document conversion
│   ├── ocr.mdx            # OCR processing
│   ├── output-formats.mdx  # Output formats
│   └── webhooks.mdx       # Webhook integration
├── configuration/          # Configuration guides
│   └── environment.mdx     # Environment variables
└── examples/              # Code examples
    └── basic-conversion.mdx # Basic usage examples

​
Development

​
Prerequisites

Node.js

Version 18+ required

Package Manager

npm or yarn

​
Installation

1

Install Mintlify CLI

npm install -g @mintlify/cli
On Windows, use the stable version:
npm install @mintlify/[email protected] --save-dev --force
2

Navigate to docs directory

cd docs
3

Start development server

mintlify dev
Use npm run dev if you have local scripts configured
The documentation will be available at http://localhost:3000.

​
Building

To build the documentation for production: 
mintlify build

​
Deployment

Recommended for ease of use
1

Sign up

Sign up at Mintlify
2

Connect repository

Connect your GitHub repository
3

Configure docs path

Configure the docs path as /docs
4

Deploy

Deploy automatically on push

​
Contributing

When adding new documentation:
1

Create MDX files

Create .mdx files in the appropriate directory
2

Update navigation

Add the page to mint.json navigation
3

Use Mintlify components

Use Mintlify components for better presentation
4

Test locally

Test locally with mintlify dev
5

Submit pull request

Submit a pull request

​
Features

Interactive Components

Cards, tabs, accordions, and more

Code Examples

Multi-language code blocks

API Documentation

Automatic API reference generation

Search

Built-in search functionality

Dark Mode

Automatic dark/light mode support

Mobile Friendly

Responsive design

SEO Optimized

Meta tags and sitemap generation

​
Mintlify Components

The documentation uses Mintlify’s special components:
  • <Card> - Feature cards and callouts
  • <CardGroup> - Group of cards
  • <Tabs> - Tabbed content
  • <AccordionGroup> - Collapsible sections
  • <CodeGroup> - Multi-language code examples
  • <ParamField> - API parameter documentation
  • <ResponseField> - API response documentation
  • <Info>, <Warning>, <Tip> - Callout boxes
  • <Steps> - Step-by-step instructions

​
Customization

​
Branding

Update mint.json to customize:

Colors and Theme

Primary colors and theme settings

Logo and Favicon

Brand assets and icons

Navigation

Navigation structure and links

Social Links

GitHub, Discord, and other links

​
Content

All content is written in MDX format, supporting:
Standard Markdown syntax

​
Support

For documentation issues:
1

Check Mintlify docs

Check the Mintlify docs
2

Open repository issue

Open an issue in the repository
3

Contact development team

Contact the development team

​
License

This documentation is part of the Document Converter project and follows the same license.