# Markline

> Open-source, self-hostable documentation framework with first-class OpenAPI, an interactive API playground, instant search, and AI on your own key (BYOK).

This index lists the documentation. The full text of every page concatenated into one file is available at [llms-full.txt](https://markline.dev/llms-full.txt).

## Documentation · Getting started

- [Quickstart](https://markline.dev/quickstart): Create and run a documentation site in under a minute.
- [CLI](https://markline.dev/cli): The markline command runs your docs project from its own markline.json and content.

## Documentation · Authoring

- [Configuration](https://markline.dev/configuration): markline.json is the single source of truth for navigation, theming, and behavior.
- [Theming](https://markline.dev/theming): Brand your docs entirely from markline.json — logo, favicon, fonts, colors, and the full palette. No code to fork.
- [Components](https://markline.dev/components): Rich components available in any MDX page — no import required.
- [API reference](https://markline.dev/openapi): Point Markline at an OpenAPI document and it generates a polished three-pane reference — resource pages, multi-language code, and a live request explorer.
- [Search](https://markline.dev/search): Full-text search across your docs and API reference — built into the static output, no service required.

## Documentation · Ship

- [Deployment](https://markline.dev/deployment): Ship your docs as static HTML or a Node server — markline init scaffolds the configs.
- [Versions & i18n](https://markline.dev/versions): Ship multiple documentation versions or languages from one project — same URL-prefix mechanism, a switcher in the header, fully static.
- [Ask AI (BYOK)](https://markline.dev/ai): An opt-in AI assistant for your docs and API reference — running on your own LLM key, never ours.
- [Feedback](https://markline.dev/feedback): "Was this helpful?" widgets on every docs page and API resource — opt-in, sink-agnostic, with a drop-in Cloudflare Worker for static hosting.

## Documentation · Compare

- [vs Mintlify](https://markline.dev/mintlify-alternative): A modern docs experience without the SaaS — MIT-licensed, self-hostable, and yours to own.
- [vs Scalar](https://markline.dev/scalar-alternative): More than an API reference — a full open-source docs framework that includes one.

## Guides · Overview

- [Framework guides](https://markline.dev/guides): Point Markline at the OpenAPI document your backend already emits — then use four small extensions to shape the reference without touching your routes.

## Guides · Node & TypeScript

- [NestJS](https://markline.dev/guides/nestjs): Emit your OpenAPI document from @nestjs/swagger, snapshot it into your docs, and shape the reference with decorators that survive regeneration.
- [Hono + Zod OpenAPI](https://markline.dev/guides/hono-zod-openapi): Define routes and schemas once with @hono/zod-openapi, write the document to disk, and drop Markline's extensions straight into createRoute.

## Guides · Python

- [FastAPI](https://markline.dev/guides/fastapi): FastAPI already emits OpenAPI 3.1 with native webhooks. Dump it to a file at build time and shape the reference with openapi_extra.

## Guides · JVM

- [Spring Boot](https://markline.dev/guides/spring-boot): Pull the document springdoc-openapi already serves at /v3/api-docs into your docs build, then shape the reference with swagger-core's @Extension annotations.

## API reference

- [API reference](https://markline.dev/api-reference): interactive OpenAPI reference
- [Projects](https://markline.dev/api-reference/projects): Create and manage documentation projects.
- [Deployments](https://markline.dev/api-reference/deployments): Build and publish a project.