> Arbitrary text to add at the BEGINNING of the page # Welcome to AnarPetstore! > Everything you need to build the best developer experience This repository is AnarPetstore Linking. This is a docs site for testing custom DEV-WITH-REPO domain FTUX for docs. Use this template to get started quickly, then replace the sample content with your own API and documentation. ## What's included This starter template contains everything you need to publish documentation: ## Getting started #### Clone this repository ```bash git clone cd docs-starter ``` #### Install the Fern CLI ```bash npm install -g fern-api ``` #### Preview locally Start a local development server with hot-reloading: ```bash fern docs dev ``` Open [http://localhost:3000](http://localhost:3000) to see your docs. #### Make it yours Update `fern.config.json` with your organization name and `docs.yml` with your desired URL: **`fern.config.json`** ```json title="fern.config.json" { "organization": "your-org-name", "version": "0.46.15" } ``` **`docs.yml`** ```yaml title="docs.yml" instances: - url: your-org.docs.dev.buildwithfern.com ``` #### Publish When you're ready to go live: ```bash fern generate --docs ``` ## API link tests Testing `api:` link resolution for the bug fix. Format: `text`. **`api:METHOD/path` — endpoint without api name (works today):** * [POST /plant](https://linking.nanoleaps.com/api-reference/endpoints/swagger-plant-store-open-api-3-1/plant/add-plant) * [GET /plant/\{plantId}](https://linking.nanoleaps.com/api-reference/endpoints/swagger-plant-store-open-api-3-1/plant/get-plant-by-id) * [GET /plant/search/status](https://linking.nanoleaps.com/api-reference/endpoints/swagger-plant-store-open-api-3-1/plant/search-plants-by-status) * [GET /user/auth/login](https://linking.nanoleaps.com/api-reference/endpoints/swagger-plant-store-open-api-3-1/user/login-user) **`api:apiName:METHOD/path` — endpoint with api name (currently broken):** * [POST /plant (named)](https://linking.nanoleaps.com/api-reference/endpoints/swagger-plant-store-open-api-3-1/plant/add-plant) * [GET /plant/\{plantId} (named)](https://linking.nanoleaps.com/api-reference/endpoints/swagger-plant-store-open-api-3-1/plant/get-plant-by-id) * [GET /user/\{username} (named)](https://linking.nanoleaps.com/api-reference/endpoints/swagger-plant-store-open-api-3-1/user/get-user-by-name) **`api:apiName` — link to API reference section root (currently not supported):** * Plant Store API ## Next steps Replace the sample Plant Store API with your own OpenAPI specification, update the Markdown pages with your content, and customize the theme to match your brand. For detailed guidance, explore the pages in this documentation or visit the [Fern documentation](https://buildwithfern.com/learn). #### [Edit your docs](/editing-your-docs) Learn how to preview and publish changes using the CLI or Fern Editor #### [Set up navigation](/navigation) Configure tabs, sections, and pages in your docs.yml file #### [Customize your docs](/customization) Brand your documentation with colors, logos, and layouts #### [API reference](/api-reference) See how Fern generates interactive API documentation > Everything you need to build the best developer experience