https://github.com/fern-api/docs-starter
Publish beautiful documentation from OpenAPI and markdown (MDX)
https://github.com/fern-api/docs-starter
api-rest get-started markdown mdx openapi-documentation swagger-documentation
Last synced: about 21 hours ago
JSON representation
Publish beautiful documentation from OpenAPI and markdown (MDX)
- Host: GitHub
- URL: https://github.com/fern-api/docs-starter
- Owner: fern-api
- Created: 2023-09-29T16:05:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-19T18:14:56.000Z (2 months ago)
- Last Synced: 2025-06-26T01:15:54.793Z (3 days ago)
- Topics: api-rest, get-started, markdown, mdx, openapi-documentation, swagger-documentation
- Language: MDX
- Homepage: https://plantstore.dev
- Size: 3.52 MB
- Stars: 28
- Watchers: 26
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docs Starter
Create beautiful documentation in under 5 minutes using an OpenAPI specification (formerly Swagger).
## Customer Showcase
Get inspired by API documentation built with Fern: [Hume](https://dev.hume.ai) | [Webflow](https://developers.webflow.com) | [Cartesia](https://docs.cartesia.ai) | [Cohere](https://docs.cohere.com) | [ElevenLabs](https://elevenlabs.io/docs)
---
## Requirements
- Node 18 or higher
- A [GitHub](https://github.com) account
### Step 1: Use this template
1. Click on the **Use this template** button (found at the top right of this page). You must be logged into GitHub.
2. Choose the option to **create a new repository**. Name it `fern-docs`.
### Step 2: Clone and open the repo in your preferred code editor
Clone your newly created repository and open it in your favorite code editor (e.g., VS Code).
The files and folders discussed in the following steps will be inside the `fern/` folder in your repository.
### Step 3: Customize your organization name
Open the `fern.config.json` file, which looks like this:
```json
{
"organization": "Plantstore",
"version": "0.17.8"
}
```
Replace `"Plantstore"` with your own organization name within the quotes. Spaces are permitted. Leave the `version` number unchanged.
Open the `docs.yml` file and locate the `url`, which looks like this:
```yml
instances:
- url: plantstore.docs.buildwithfern.com
```
Replace `plantstore` with your own organization's name. Use only alphanumeric characters, hyphens, and underscores. Do not use spaces, and leave the rest of the URL (`docs.buildwithfern.com`) unchanged.
### Step 4: Install the Fern CLI
Install the Fern CLI globally by running:
```bash
npm install -g fern-api
```
The CLI commands in the following steps must be run from within the root folder of your repository.
### Step 5: Generate your documentation
Run the following command:
```bash
fern generate --docs
```
You will be prompted to log in and connect your GitHub account.
Once the documentation is generated, you will receive the URL where your documentation is published. For example:
```shell
┌─
│ ✓ plantstore.docs.buildwithfern.com
└─
# OR
┌─
│ ✓ MY_ORGANIZATION_NAME.docs.buildwithfern.com
└─
```
### Step 6: Try local development
Preview your documentation locally. Run `fern docs dev` to access your docs on your local server at port 3000, hot-reloading as you edit your markdown and OpenAPI files. [Learn more](https://buildwithfern.com/learn/docs/getting-started/development?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step6) or [watch a 10-second demo](https://www.loom.com/share/0a4658bd78cb45d5a9519277852c7a24?sid=3ce69ad0-bfdb-4fa1-9abf-2f4366d084b9).
### Step 7: Customize your documentation
You must run `fern generate --docs` after any modifications to re-generate and publish your documentation site.
To preview updates to your documentation before publishing changes, run `fern generate --docs --preview`.
To use your own OpenAPI specification file or to update the existing one:
- Update or replace the OpenAPI specification file in the `openapi/` folder.
- _Note: Don't have an OpenAPI spec? Use Fern's simpler format to define your API._ [_Learn more_](https://github.com/fern-api/docs-starter-fern-definition?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7).
To modify the other docs pages:
- Update the Markdown files located in the `docs/pages/` folder, such as `welcome.mdx`.
To modify site styles and navigation, or to add new pages:
- See [Writing Content](https://buildwithfern.com/learn/docs/content/write-markdown?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7).
To learn about Fern's built-in component library you can use within MDX files:
- See the [Component Library](https://buildwithfern.com/learn/docs/content/components/overview?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7).
### Step 8: Set up a custom domain
If you wish to use a custom subdomain like `https://docs.YOUR_ORGANIZATION.com` or a subpath like `https://YOUR_ORGANIZATION.com/docs`, you can subscribe to the [Starter plan](https://buildwithfern.com/pricing?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step8). Once subscribed, update `docs.yml` with the custom domain configuration:
```yaml
- url: plantstore.docs.buildwithfern.com
custom-domain: plantstore.dev
```
### Step 9: Explore advanced features
For advanced documentation features and options, view the full [project structure](https://buildwithfern.com/learn/docs/getting-started/project-structure?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step9).
Good luck creating beautiful and functional documentation! 🌿
---
## Support
Need help? [Set up a call](https://buildwithfern.com/contact?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=support) with an expert or email us at [[email protected]](mailto:[email protected]).