Docs starter

Create beautiful documentation in under 5 minutes using your OpenAPI specification.

Customer showcase

Get inspired by API documentation built with Fern: Webflow | You.com | Cohere | ElevenLabs

---

Requirements

• Node 18 or higher
• A GitHub account
• Knowledge of the command line

Getting started

Prefer a no-code setup? Use the guided UI to get started from your browser instead.

Follow the steps below, or see the Docs quickstart for a more detailed walkthrough.

1. Install the CLI

   npm install -g fern-api

2. Initialize your docs

   Clone this starter template, or run fern init --docs to start from scratch.

3. Configure your organization

   Set your organization name in fern.config.json and your docs URL in docs.yml:

   // fern.config.json
   { "organization": "your-org-name", "version": "4.21.3" }

   # docs.yml
   instances:
     - url: your-org-name.docs.buildwithfern.com

4. Preview locally

   fern docs dev

5. Publish

   fern generate --docs

Customize your docs

Once you're up and running, you can tailor your docs site to match your brand and product:

• Brand your docs — Set custom colors, logo, favicon, and fonts in docs.yml
• Add an API reference — Auto-generate interactive API docs from your OpenAPI spec
• Use components — Tabs, accordions, callouts, cards, and more out of the box
• Set up a custom domain — Host on your own domain (e.g., docs.example.com)
• Configure analytics — Integrate with PostHog, Segment, Google Tag Manager, and others
• Customize navigation — Add versioned docs, tabs, nested sections, and multi-product layouts

---

Support

Need help? Set up a call with an expert or email us at support@buildwithfern.com.