This website is built using Fern.
- Node 18 or higher
- A GitHub account
- Knowledge of the command line
Install the Fern Command Line Interface (CLI) by running:
npm install -g fern-apiThe files and folders discussed in the following steps will be inside the fern/ folder in your repository.
fern docs devIf you need to resync the live docs and redeploy from local to prod, checkout your git repo locally, pull the latest from the main branch, and run the following command:
fern generate --docsYou will be prompted to log in and connect your GitHub account.
You might also be prompted, yes or no, about if you want to proceed with generating docs and informed that you can choose between using the --preview flag or not. You can choose to use either fern generate --docs or fern generate --docs --preview at this time. This decision is important later, when you are making changes that might affect a production docs environment, but it won't impact your docs project now.
You can generate documentation previews
To preview updates to your documentation before publishing changes, run fern generate --docs --preview.
To modify site styles and navigation, or to add new pages:
- See Writing Content.
To learn about Fern's built-in component library you can use within MDX files:
- See the Component Library.