{"id":28401204,"url":"https://github.com/fern-api/docs-starter-fern-definition","last_synced_at":"2025-06-28T13:31:53.994Z","repository":{"id":221550782,"uuid":"754680672","full_name":"fern-api/docs-starter-fern-definition","owner":"fern-api","description":"Publish beautiful documentation in under 5 minutes using a Fern Definition.","archived":false,"fork":false,"pushed_at":"2024-08-09T13:18:26.000Z","size":611,"stargazers_count":2,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-26T01:15:54.867Z","etag":null,"topics":["api-docs-generator","api-reference","fern-definition","mdx","product-documentation"],"latest_commit_sha":null,"homepage":"https://petstore-ferndef.docs.buildwithfern.com/","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fern-api.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-08T15:07:22.000Z","updated_at":"2025-03-06T15:12:42.000Z","dependencies_parsed_at":"2024-02-08T17:30:58.822Z","dependency_job_id":"facbbd5d-41bb-4e52-9126-cfd0c8d54377","html_url":"https://github.com/fern-api/docs-starter-fern-definition","commit_stats":null,"previous_names":["fern-api/docs-starter-fern-definition"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/fern-api/docs-starter-fern-definition","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter-fern-definition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter-fern-definition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter-fern-definition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter-fern-definition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fern-api","download_url":"https://codeload.github.com/fern-api/docs-starter-fern-definition/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter-fern-definition/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262437901,"owners_count":23311054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-docs-generator","api-reference","fern-definition","mdx","product-documentation"],"created_at":"2025-06-01T11:38:07.098Z","updated_at":"2025-06-28T13:31:53.989Z","avatar_url":"https://github.com/fern-api.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cbr/\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.buildwithfern.com/?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=docs-starter-openapi\u0026utm_content=logo\"\u003e\n    \u003cimg src=\"/fern/docs/assets/fern-logo.png\" height=\"50\" align=\"center\" alt=\"header\" /\u003e\n  \u003c/a\u003e\n  \n  \u003cbr/\u003e\n\n# Fern Docs Quickstart with Fern Definition\n\nCreate beautiful documentation in under 5 minutes, using the Fern Definition format to define your API.\n\n\u003c/div\u003e\n\n## Customer Showcase\n\nGett inspired by API documentation built with Fern: [Hume](https://dev.hume.ai) | [MultiOn](https://docs.multion.ai) | [Flagright](https://docs.flagright.com) | [Traceloop](https://fern.traceloop.com/docs) | [ElevenLabs](https://elevenlabs.docs.buildwithfern.com/docs/developers)\n\n---\n\n## Requirements\n\n- Node 18 or higher\n- A [GitHub](https://github.com) account\n\n\u003e [!TIP]\n\u003e Prefer to use OpenAPI? We've got you covered: [Fern Docs Quickstart with OpenAPI Specification](https://github.com/fern-api/docs-starter-openapi).\n\n### Step 1: Use this template\n\n1. Click on the **Use this template** button. You must be logged into GitHub.\n2. Choose the option to **create a new repository**. Name it `fern-docs`.\n\n### Step 2: Clone and open the repository in your preferred code editor\n\nClone your newly created repository locally and open it in your favorite code editor, such as [Visual Studio Code](https://code.visualstudio.com/).\n\nThe `fern/` folder in your repository contains these files and folders:\n\n```yml\n├─ definition/\n  ├─ api.yml\n  ├─ pet.yml\n  ├─ store.yml\n  └─ user.yml\n├─ docs/\n  ├─ assets/\n    ├─ favicon.png\n    ├─ logo_dark_mode.png\n    └─ logo_light_mode.png\n  └─ pages/\n    ├─ sdks.mdx\n    └─ welcome.mdx\n    ├─ docs.yml\n├─ fern.config.json\n└─ generators.yml\n```\n\nThe `definition/` folder contains Fern Definition files for a sample API called Swagger Petstore. Fern uses these files to generate the API Reference section of your docs site.\n\nThe files inside the `pages/` folder are used to generate other documentation pages, such as a Welcome page. The `docs.yml` file sets up site navigation and custom styles.\n\n### Step 3: Customize organization name and url\n\nIn the repository that you cloned locally, open the `fern.config.json` file, which looks like this:\n\n```json\n{\n  \"organization\": \"Petstore\",\n  \"version\": \"0.x.x\"\n}\n```\n\nReplace `\"Petstore\"` with your own organization name within the quotes. Spaces are permitted. Leave the `version` number unchanged.\n\nOpen the `docs.yml` file and locate the `url`, which looks like this:\n\n```yml\ninstances:\n  - url: petstore-ferndef.docs.buildwithfern.com\n```\n\nReplace `petstore-ferndef` 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.\n\n### Step 4: Install the Fern CLI tool\n\nInstall the Fern CLI tool globally by running:\n\n```shell\nnpm install -g fern-api\n```\n\nWhen prompted, log into and connect your GitHub account.\n\n\u003e [!NOTE]  \n\u003e The above CLI command is a global command that you can run from any location. The `fern` commands in the following steps must be run from within your repository.\n\n### Step 5: Generate your documentation\n\nRun the following command:\n\n```bash\nfern generate --docs\n```\n\nOnce the documentation is generated, Fern displays the URL where you can view the published documentation. For example:\n\n```shell\n┌─\n│ ✓  petstore-ferndef.docs.buildwithfern.com\n└─\n```\n\nInstead of `petstore-ferndef`, you should see the organization name that you added to `docs.yml` in Step 3.\n\n### Step 6: Customize your documentation\n\nYou must run `fern generate --docs` after any modifications to re-generate and publish your documentation site.\n\nTo preview updates to your documentation before publishing changes, run `fern generate --docs --preview`.\n\nTo modify the API Reference:\n\n- Update or replace the Fern Definition files in the `definition/` folder. See our documentation on [how to define your API with Fern Definition](https://buildwithfern.com/learn/overview/define-your-api/ferndef/overview).\n\nTo modify the other docs pages or add new pages:\n\n- Update the files located in the `docs/pages/` folder, such as `welcome.mdx`. See our documentation on [how to write Markdown content](https://buildwithfern.com/learn/docs/content/write-markdown).\n\nTo configure site navigation, styles, and see other configuration options:\n\n- See [Fern Docs Configuration Overview](https://buildwithfern.com/learn/docs/config/overview).\n\nTo learn about Fern's built-in component library you can use in Markdown:\n\n- See the [Component Library](https://buildwithfern.com/learn/docs/components).\n\n### Step 7: Set up a custom domain\n\nIf 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). Once subscribed, update `docs.yml` with the custom domain configuration, replacing YOUR_ORGANIZATION with your own.\n\n```yaml\n- url: YOUR_ORGANIZATION.docs.buildwithfern.com\n  custom-domain: docs.YOUR_ORGANIZATION.com\n```\n\nGood luck creating beautiful and functional documentation! 🌿\n\n---\n\n## Support\n\nNeed help? [Set up a call](https://buildwithfern.com/contact) with an expert or email us at [support@buildwithfern.com](mailto:support@buildwithfern.com). \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffern-api%2Fdocs-starter-fern-definition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffern-api%2Fdocs-starter-fern-definition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffern-api%2Fdocs-starter-fern-definition/lists"}