Getting Started

Welcome to Padle, beautiful API documentation shipped in minutes. This guide will take you from zero to a live docs site in about five minutes.

Create Your Account

Head to https://padle.co and click Get started. You can sign up with email or use Google or GitHub for one-click authentication.

Create Your First Project

From the dashboard, click New Project and fill in:

• Project Name
  The display name for your API (for example: "Acme API")

• Project Slug
  Auto-generated from your name. This becomes your project path and cannot be changed later.

• Description
  A short summary of what your API does.

Your docs are immediately live at: your-subdomain.padle.co

Add an Endpoint

Navigate to Endpoints and click Add Endpoint. Fill in the basics:

• Method
  GET, POST, PUT, PATCH, or DELETE

• Path
  Example: /users/{id}

• Title and description
  What this endpoint does in plain language

You can add parameters, request bodies, and response examples later. For now, just get something on the page. Padle automatically generates code examples in cURL, JavaScript, Python, and more.

Write a Guide

Navigate to Guides and click Add Guide. Give it a title, write some Markdown, and save.

Guides are great for tutorials, authentication walkthroughs, or anything that is not a raw API reference.

See It Live

Open the following in your browser: your-subdomain.padle.co

Your endpoint and guide are already there, searchable, navigable, and ready to share.

What's Next

Now that your docs are live, you can:

• Add more endpoints
  Define parameters, request and response examples, and status codes

• Write more guides
  Markdown-based pages for tutorials and walkthroughs

• Set up versioning
  Manage multiple API versions side by side

• Customize appearance
  Match your docs to your brand with colors, fonts, and logos

• Configure settings
  Set your base URL, authentication type, and header links

• Explore analytics
  See how developers use your docs