Project Structure
This page provides an overview of the file and folder structure of a Fern Docs project. The following structure is recommended for organizing your documentation content, but is customizable to fit your needs.
Top-level Folders
A Fern Docs project has the following top-level folders:
pages: Contains the Markdown (MDX) files that make up your documentation.assets: Contains any images or videos used in your documentation.docs.yml: The configuration file that defines the navigation, theme, and hosting details of your documentation.openapi: Contains the OpenAPI specification file (if you have an API Reference section in your documentation).fern.config.json: The configuration file specifying your organization name and CLI version.
Pages Folder
The pages folder contains the Markdown (MDX) files that make up your documentation. Each MDX file represents a page in your documentation.
The pages folder is organized into subfolders based on the sections of your documentation. Each subfolder contains the MDX files for the pages in that section.
Assets Folder
The assets folder contains any images or videos used in your documentation. You can reference these assets in your MDX files using relative paths.
docs.yml
The docs.yml file is the configuration file that defines the navigation, theme, and hosting details of your documentation. You can customize the appearance and behavior of your documentation by editing this file.
API Definitions
fern.config.json
The fern.config.json file specifies your organization name and the version of the Fern CLI used to generate the documentation. You can customize this file to reflect your organization’s details.