Quickstart

Create and run a documentation site in under a minute.

Install & scaffold

Scaffold a project

npm create @markline@latest my-docs

This creates a markline.json, sample MDX pages, an example OpenAPI spec, and ready-to-use deploy configs.

Install & run

cd my-docs
npm install
npm run dev

Already have a project? npm install @markline/markline then npx markline init.

Project structure

Your repository holds only content and configuration:

my-docs/
├── markline.json     # navigation, theme, branding, API settings
├── docs/             # your pages (*.mdx)
│   ├── index.mdx
│   └── quickstart.mdx
└── api/
    └── openapi.json   # rendered as an interactive API reference

The OpenAPI file is optional — Markline works as a docs-only site too.

Develop

Edit files under docs/ and update markline.json to change navigation, branding, and the API base URL. When you're ready, see Deployment.

CLI

Edit this page on GitHub