{"repo":"fern-api/docs-starter","free":true,"listed":false,"github":"https://github.com/fern-api/docs-starter","clone":"git clone https://github.com/fern-api/docs-starter.git","description":"Publish beautiful documentation from OpenAPI and markdown (MDX)","language":"MDX","stars":43,"topics":["api-rest","get-started","openapi-documentation","swagger-documentation","markdown","mdx"],"license":null,"category":"api-integrations-sdks","readme_excerpt":"Docs Starter Create beautiful documentation in under 5 minutes using your OpenAPI specification. Customer showcase Get inspired by API documentation built with Fern: Webflow You.com Cohere ElevenLabs --- Requirements - Node.js 22+ (required for npm install ) or Homebrew (macOS/Linux) - A GitHub account - A Fern account (free to start) Installation Install the Fern CLI globally using one of the following methods: npm (all platforms): Homebrew (macOS / Linux): Verify the installation: Repository structure Getting started This repository is the official starter template for Fern Docs — the same one used in the Fern Docs quickstart. The steps below get you publishing; the quickstart walks through the same flow with more narration and screenshots. Prefer a no-code setup? Use the guided UI to get started from your browser instead. 1. Create your repository. Click \"Use this template\" on GitHub and clone the result, or use the GitHub CLI. To start from an empty project instead, run fern init --docs . 2. Configure your organization. Set your organization name in fern/fern.config.json and your docs URL in fern/docs.yml : 3. Validate your configuration. 4. Preview locally with hot-reloading at localhost:3000. 5. Publish to go live, or add --preview for a shareable preview URL. Run fern login once first to authenticate; the credential is cached for future runs. CI/CD workflows This template includes three GitHub Actions workflows out of the box: Workflow Trigger What it does ---------- -","default_branch":null,"files":null,"tree":[],"storefront":"/r/fern-api","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/fern-api/docs-starter/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}