Welcome to Fern! | Fern Docs Starter

This repository is a starter template for building documentation with Fern. It includes a sample Plant Store API to demonstrate how Fern generates interactive API reference documentation from an OpenAPI specification.

Use this template to get started quickly, then replace the sample content with your own API and documentation.

What’s included

This starter template contains everything you need to publish documentation:

docs.yml# Configures navigation, theme, and hosting

fern.config.json# Sets your organization name and CLI version

openapi.yaml# Sample Plant Store API specification

docs

pages# Markdown content for your documentation

assets# Logos, favicon, and other assets

Getting started

Clone this repository

$ git clone <your-template-repo.git>
> cd docs-starter

Install the Fern CLI

$ npm install -g fern-api

Preview locally

Start a local development server with hot-reloading:

$ fern docs dev

Open http://localhost:3000 to see your docs.

Make it yours

Update fern.config.json with your organization name and docs.yml with your desired URL:

fern.config.json

1 {
2   "organization": "your-org-name",
3   "version": "0.46.15"
4 }

docs.yml

1 instances:
2   - url: your-org.docs.buildwithfern.com

Publish

When you’re ready to go live:

$ fern generate --docs

Next steps

Replace the sample Plant Store API with your own OpenAPI specification, update the Markdown pages with your content, and customize the theme to match your brand. For detailed guidance, explore the pages in this documentation or visit the Fern documentation.

Edit your docs

Learn how to preview and publish changes using the CLI or Fern Editor

Set up navigation

Configure tabs, sections, and pages in your docs.yml file

Customize your docs

Brand your documentation with colors, logos, and layouts

API reference

See how Fern generates interactive API documentation