Inside page

Quickstart

Ready to create stellar, interactive API documentation? Get your developer hub up and running in minutes!

Step 1: Create your project

First things first – give your API documentation a home:

1. Sign into your ReadMe account
2. Click "Create New Project"
3. Give your project a name that resonates with your API
4. Upload your logo (we work our magic to match your brand colors!)

Step 2: Add Your OpenAPI Specification

Here's where the real magic happens! We transform your OpenAPI spec into engaging, interactive documentation. You have two great options:

Step 3: Create Your First Guide

Time to make your docs shine! You're greeted with a Getting Started page in View mode – transform it into something awesome:

1. Click the Edit button in the top navigation (look for that friendly pencil icon!)
2. Click "+ NEW CATEGORY" to create a home for your getting started guides
3. Name your category "Getting Started" – this is your developers' first stop
4. See that "+" button next to your new Getting Started category? Click it to create your first guide page
5. Time to write! Hit the '/' key while writing to summon our handy menu of content blocks and components:
   • Craft your documentation with Markdown
   • Drop in code blocks that developers can copy to try out
   • Spice things up with custom components