Official documentation for Massimo - a powerful tool for generating typed HTTP clients from OpenAPI and GraphQL APIs.
The main branch is published on https://massimohttp.dev
- Node.js 18+ installed
- npm or pnpm package manager
# Install dependencies
npm install
# Start development server
npm run dev
# Build for production
npm run build
# Preview production build
npm run previewThe development server will start at http://localhost:4321.
massimo-docs/
├── src/
│ ├── assets/ # Images and logos
│ ├── content/
│ │ └── docs/ # Documentation markdown files
│ │ ├── index.mdx # Homepage
│ │ ├── getting-started.md # Getting started guide
│ │ └── reference/ # API reference docs
│ │ ├── overview.md # CLI reference
│ │ ├── frontend.md # Frontend client docs
│ │ ├── programmatic.md # Programmatic API
│ │ └── errors.md # Error reference
│ └── styles/ # Custom CSS styles
├── astro.config.mjs # Astro configuration
├── package.json
└── README.md
- Create a new
.mdor.mdxfile insrc/content/docs/ - Add frontmatter with title and description:
---
title: Your Page Title
description: Brief description of the page
---
# Your content here- Update the sidebar in
astro.config.mjsif needed
- Use clear, concise language
- Include code examples for all features
- Provide both JavaScript and TypeScript examples where applicable
- Test all code examples before committing
- Use proper markdown formatting and headers
When adding code examples:
```js
// JavaScript example
import client from './api.js'
const api = await client({ url: 'https://api.example.com' })
const users = await api.getUsers()
```
```typescript
// TypeScript example
import client from './api'
import type { User } from './api-types'
const api = await client({ url: 'https://api.example.com' })
const users: User[] = await api.getUsers()
```All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Custom styles are located in src/styles/custom.css. The documentation uses the Platformatic brand colors and fonts.
Edit the sidebar configuration in astro.config.mjs to modify the navigation structure.
This documentation is part of the Massimo project and follows the same license terms.