Welcome to Fern! | willktrial

Table examples

Basic markdown table

Name	Type	Required	Description
`organization`	string	Yes	Your organization’s unique identifier
`version`	string	Yes	The Fern CLI version to use
`url`	string	Yes	The public URL for your docs site
`title`	string	No	Browser tab title for your docs
`favicon`	string	No	Path to your favicon file

Searchable table

Parameter	Type	Default	Description
`background`	`light` \| `dark`	`light`	Background color scheme
`primary`	color hex	`#000000`	Primary brand color
`accent`	color hex	—	Accent color for links and highlights
`logo`	path	—	Path to your logo image
`favicon`	path	—	Path to your favicon
`font`	string	system	Custom font family name
`border-radius`	`none` \| `sm` \| `md` \| `lg`	`md`	Border radius for UI elements
`sidebar-width`	px value	`300px`	Width of the navigation sidebar
`content-width`	px value	`720px`	Max width of the content area
`header-height`	px value	`64px`	Height of the top navigation bar

Paginated table

SDK	Language	Status	Install
TypeScript	TypeScript / JavaScript	GA	`npm install @your-org/sdk`
Python	Python 3.8+	GA	`pip install your-org`
Java	Java 11+	GA	Maven / Gradle
Go	Go 1.19+	GA	`go get github.com/your-org/sdk-go`
Ruby	Ruby 2.7+	Beta	`gem install your-org`
C#	.NET 6+	Beta	NuGet
PHP	PHP 8.0+	Beta	Composer
Swift	Swift 5.7+	Coming soon	Swift Package Manager
Kotlin	Kotlin 1.7+	Coming soon	Maven Central
Rust	Rust 1.65+	Coming soon	Cargo
Scala	Scala 2.13+	Planned	sbt
Elixir	Elixir 1.13+	Planned	Hex

1–10 of 12

SDK	Language	Status	Install
TypeScript	TypeScript / JavaScript	GA	`npm install @your-org/sdk`
Python	Python 3.8+	GA	`pip install your-org`
Java	Java 11+	GA	Maven / Gradle
Go	Go 1.19+	GA	`go get github.com/your-org/sdk-go`
Ruby	Ruby 2.7+	Beta	`gem install your-org`
C#	.NET 6+	Beta	NuGet
PHP	PHP 8.0+	Beta	Composer
Swift	Swift 5.7+	Coming soon	Swift Package Manager
Kotlin	Kotlin 1.7+	Coming soon	Maven Central
Rust	Rust 1.65+	Coming soon	Cargo
Scala	Scala 2.13+	Planned	sbt
Elixir	Elixir 1.13+	Planned	Hex

1–5 of 12

Paginated + searchable table

Method	Endpoint	Auth	Description
`GET`	`/plants`	Optional	List all plants in the store
`POST`	`/plants`	Required	Create a new plant listing
`GET`	`/plants/{id}`	Optional	Get a plant by ID
`PATCH`	`/plants/{id}`	Required	Update an existing plant
`DELETE`	`/plants/{id}`	Required	Delete a plant listing
`GET`	`/plants/search`	Optional	Search plants by name or category
`GET`	`/categories`	Optional	List all plant categories
`POST`	`/categories`	Required	Create a new category
`GET`	`/orders`	Required	List orders for the current user
`POST`	`/orders`	Required	Place a new order
`GET`	`/orders/{id}`	Required	Get order details
`DELETE`	`/orders/{id}`	Required	Cancel an order
`GET`	`/users/me`	Required	Get the current user profile
`PATCH`	`/users/me`	Required	Update the current user profile
`POST`	`/auth/token`	None	Exchange credentials for a token

1–5 of 15

everyone

Untitled

This is tab1. Goto term: h1
Goto term: h2
Goto term: h3
Goto term: h4
Goto term: h5
Goto term: anchor

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

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

docs.yml

instances:
  - 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