{"id":28401210,"url":"https://github.com/fern-api/docs-starter","last_synced_at":"2025-06-28T13:31:52.409Z","repository":{"id":197274089,"uuid":"698306387","full_name":"fern-api/docs-starter","owner":"fern-api","description":"Publish beautiful documentation from OpenAPI and markdown (MDX)","archived":false,"fork":false,"pushed_at":"2025-04-19T18:14:56.000Z","size":3695,"stargazers_count":28,"open_issues_count":3,"forks_count":11,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-06-26T01:15:54.793Z","etag":null,"topics":["api-rest","get-started","markdown","mdx","openapi-documentation","swagger-documentation"],"latest_commit_sha":null,"homepage":"https://plantstore.dev","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,"publiccode":null,"codemeta":null}},"created_at":"2023-09-29T16:05:17.000Z","updated_at":"2025-06-13T21:39:14.000Z","dependencies_parsed_at":"2023-10-02T19:36:58.568Z","dependency_job_id":"64657104-90cf-4509-b6ac-066cee77790a","html_url":"https://github.com/fern-api/docs-starter","commit_stats":null,"previous_names":["fern-api/docs-starter","fern-api/docs-starter-openapi"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/fern-api/docs-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fern-api","download_url":"https://codeload.github.com/fern-api/docs-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fern-api%2Fdocs-starter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262437894,"owners_count":23311051,"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-rest","get-started","markdown","mdx","openapi-documentation","swagger-documentation"],"created_at":"2025-06-01T11:38:08.740Z","updated_at":"2025-06-28T13:31:52.404Z","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# Docs Starter\n\nCreate beautiful documentation in under 5 minutes using an OpenAPI specification (formerly Swagger).\n\n\u003c/div\u003e\n\n## Customer Showcase\n\nGet 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)\n\n---\n\n## Requirements\n\n- Node 18 or higher\n- A [GitHub](https://github.com) account\n\n### Step 1: Use this template\n\n1. Click on the **Use this template** button (found at the top right of this page). 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 repo in your preferred code editor\n\nClone your newly created repository and open it in your favorite code editor (e.g., VS Code).\n\nThe files and folders discussed in the following steps will be inside the `fern/` folder in your repository.\n\n### Step 3: Customize your organization name\n\nOpen the `fern.config.json` file, which looks like this:\n\n```json\n{\n  \"organization\": \"Plantstore\",\n  \"version\": \"0.17.8\"\n}\n```\n\nReplace `\"Plantstore\"` 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: plantstore.docs.buildwithfern.com\n```\n\nReplace `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.\n\n### Step 4: Install the Fern CLI\n\nInstall the Fern CLI globally by running:\n\n```bash\nnpm install -g fern-api\n```\n\nThe CLI commands in the following steps must be run from within the root folder of your repository.\n\n### Step 5: Generate your documentation\n\nRun the following command:\n\n```bash\nfern generate --docs\n```\n\nYou will be prompted to log in and connect your GitHub account.\n\nOnce the documentation is generated, you will receive the URL where your documentation is published. For example:\n\n```shell\n┌─\n│ ✓  plantstore.docs.buildwithfern.com\n└─\n\n# OR\n\n┌─\n│ ✓  MY_ORGANIZATION_NAME.docs.buildwithfern.com\n└─\n```\n\n### Step 6: Try local development\n\nPreview 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\u0026utm_medium=readme\u0026utm_campaign=docs-starter-openapi\u0026utm_content=step6) or [watch a 10-second demo](https://www.loom.com/share/0a4658bd78cb45d5a9519277852c7a24?sid=3ce69ad0-bfdb-4fa1-9abf-2f4366d084b9).\n\n### Step 7: 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 use your own OpenAPI specification file or to update the existing one:\n\n- Update or replace the OpenAPI specification file in the `openapi/` folder.\n- _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\u0026utm_medium=readme\u0026utm_campaign=docs-starter-openapi\u0026utm_content=step7).\n\nTo modify the other docs pages:\n\n- Update the Markdown files located in the `docs/pages/` folder, such as `welcome.mdx`.\n\nTo modify site styles and navigation, or to add new pages:\n\n- See [Writing Content](https://buildwithfern.com/learn/docs/content/write-markdown?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=docs-starter-openapi\u0026utm_content=step7).\n\nTo learn about Fern's built-in component library you can use within MDX files:\n\n- See the [Component Library](https://buildwithfern.com/learn/docs/content/components/overview?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=docs-starter-openapi\u0026utm_content=step7).\n\n### Step 8: 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?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=docs-starter-openapi\u0026utm_content=step8). Once subscribed, update `docs.yml` with the custom domain configuration:\n\n```yaml\n- url: plantstore.docs.buildwithfern.com\n  custom-domain: plantstore.dev\n```\n\n### Step 9: Explore advanced features\n\nFor advanced documentation features and options, view the full [project structure](https://buildwithfern.com/learn/docs/getting-started/project-structure?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=docs-starter-openapi\u0026utm_content=step9).\n\nGood luck creating beautiful and functional documentation! 🌿\n\n---\n\n## Support\n\nNeed help? [Set up a call](https://buildwithfern.com/contact?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=docs-starter-openapi\u0026utm_content=support) 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","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffern-api%2Fdocs-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffern-api%2Fdocs-starter/lists"}