Welcome to Fern!

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:

Getting started

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

$
npm install -g fern-api

$
fern docs dev

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

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

$
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.