welcome.mdx

title	Welcome to Fern!
subtitle	Everything you need to build the best developer experience
slug	welcome

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

Start a local development server with hot-reloading:

fern docs dev

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

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

{
  "organization": "your-org-name",
  "version": "0.46.15"
}

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

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.

Learn how to preview and publish changes using the CLI or Fern Editor Configure tabs, sections, and pages in your docs.yml file Brand your documentation with colors, logos, and layouts See how Fern generates interactive API documentation

This is a test line.