From 646ece13e51ec4b467130c0c501f22051df31b18 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Tue, 7 Oct 2025 02:14:21 +0000 Subject: [PATCH] Visual Editor: Update --- .../docs/pages/getting-started/overview.mdx | 2 +- .../getting-started/project-structure.mdx | 10 +- .../docs/pages/getting-started/quickstart.mdx | 121 +++++++++--------- 3 files changed, 66 insertions(+), 67 deletions(-) diff --git a/fern/products/docs/pages/getting-started/overview.mdx b/fern/products/docs/pages/getting-started/overview.mdx index 8d333869..0c010c2d 100644 --- a/fern/products/docs/pages/getting-started/overview.mdx +++ b/fern/products/docs/pages/getting-started/overview.mdx @@ -155,4 +155,4 @@ subtitle: A website builder for beautiful agent and developer-friendly docs. - + \ No newline at end of file diff --git a/fern/products/docs/pages/getting-started/project-structure.mdx b/fern/products/docs/pages/getting-started/project-structure.mdx index f1c0bd1e..b48d542f 100644 --- a/fern/products/docs/pages/getting-started/project-structure.mdx +++ b/fern/products/docs/pages/getting-started/project-structure.mdx @@ -53,6 +53,8 @@ The `pages` folder is organized into subfolders based on the sections of your do The `assets` folder contains any images or videos used in your documentation. You can reference these assets in your MDX files using relative paths. +Hellooo this is deep!! + ```bash assets @@ -166,11 +168,11 @@ title: Fern's Documentation - If you're using Fern for both API Reference documentation and SDKs, you'll use both `docs.yml` (the Docs configuration file) and `generators.yml` ([the SDK configuration file](/sdks/overview/project-structure#generatorsyml)) to configure [how SDK code snippets appear](/docs/api-references/sdk-snippets) in your API reference documentation. + If you're using Fern for both API Reference documentation and SDKs, you'll use both `docs.yml` (the Docs configuration file) and `generators.yml` ([the SDK configuration file](/sdks/overview/project-structure#generatorsyml)) to configure [how SDK code snippets appear](/docs/api-references/sdk-snippets) in your API reference documentation. If you're only using Fern for API Reference docs, not SDKs, your `generators.yml` should simply link to your spec: - ```yaml title="generators.yml" + ```yaml api: specs: - openapi: ../openapi/openapi.json @@ -189,6 +191,4 @@ The `fern.config.json` file specifies your organization name and the version of "version": "" } ``` - - - + \ No newline at end of file diff --git a/fern/products/docs/pages/getting-started/quickstart.mdx b/fern/products/docs/pages/getting-started/quickstart.mdx index a53c14f7..8fc1b1f3 100644 --- a/fern/products/docs/pages/getting-started/quickstart.mdx +++ b/fern/products/docs/pages/getting-started/quickstart.mdx @@ -11,12 +11,12 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. ### Initialize your `fern` folder - - All the configurations for your docs live in the `fern` folder. Inside, you'll - find a `docs.yml` file that contains all the settings for your documentation. + + All the configurations for your docs live in the `fern` folder. Inside, you'll + find a `docs.yml` file that contains all the settings for your documentation. - + Get started by cloning the [starter template](https://github.com/fern-api/docs-starter). @@ -31,35 +31,35 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. Next, please update the template settings to use your organization. - Please edit the details `fern.config.json` and `docs.yml` with your organization - name. + Please edit the details `fern.config.json` and `docs.yml` with your organization name. - ```json {2} - { - "organization": "{{YOUR_ORGANIZATION}}", - "version": "0.x.x" - } - ``` + ```json {2} + { + "organization": "{{YOUR_ORGANIZATION}}", + "version": "0.x.x" + } + ``` - ```yml {2} - instances: - - url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com - ``` + ```yml {2} + instances: + - url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com + ``` + Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation: ```bash fern generate --docs ``` - - If you prefer, you can use our CLI to create a new project. Install the CLI - by running + + + If you prefer, you can use our CLI to create a new project. Install the CLI by running ```bash npm install -g fern-api @@ -78,13 +78,13 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. ├─ docs.yml └─ fern.config.json ``` + Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation: ```bash fern generate --docs ``` - ### Update your docs @@ -95,9 +95,9 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. - - Add content with MDX files. - + + Add content with MDX files. + ```markdown --- title: "Page Title" @@ -108,13 +108,12 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. ``` - Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required. + Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required. - In order for the Markdown page to show up, you'll need to reference them from your `docs.yml` file. You - can reference the Markdown page within a section or as a standalone page. + In order for the Markdown page to show up, you'll need to reference them from your `docs.yml` file. You can reference the Markdown page within a section or as a standalone page. - ```yml + ``` navigation: - page: Hello World path: docs/pages/hello-world.mdx @@ -124,80 +123,80 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. path: docs/pages/hello-world.mdx ``` - + + Add an API Reference by adding an OpenAPI Specification to your project. ```bash fern init --openapi /path/to/openapi.yml ``` - This will create an `openapi.yml` file in your project. You can reference this file in your - `docs.yml` file by adding an api block. + This will create an `openapi.yml` file in your project. You can reference this file in your `docs.yml` file by adding an api block. - ```yml + ``` navigation: - api: "API Reference" ``` - + + All of the branding for your docs can be configured in the `docs.yml` file. - For example, to set the logos, colors, and fonts for your docs, you can - add the following to your `docs.yml` file: + For example, to set the logos, colors, and fonts for your docs, you can add the following to your `docs.yml` file: - ```yml - colors: - accent-primary: - dark: "#f0c193" - light: "#af5f1b" - - logo: - dark: docs/assets/logo-dark.svg - light: docs/assets/logo-light.svg - height: 40 - href: https://buildwithfern.com/ - - favicon: docs/assets/favicon.svg - ``` + ```yml + colors: + accent-primary: + dark: "#f0c193" + light: "#af5f1b" + + logo: + dark: docs/assets/logo-dark.svg + light: docs/assets/logo-light.svg + height: 40 + href: https://buildwithfern.com/ + + favicon: docs/assets/favicon.svg + ``` - - - + ### Preview your docs + - + You can preview your docs locally for testing purposes by following the instructions [here](/docs/preview-publish/previewing-changes-locally). - + + `PR previews` offer a way to preview changes from pull requests (PRs) before merging code to a production branch. Learn more [here](/docs/preview-publish/previewing-changes-in-a-pr). - + ### Publish to production - + When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI. [Read more.](/learn/docs/preview-publish/publishing-your-docs) - - Fern supports hosting your docs website on a custom domain or on a + + + Fern supports hosting your docs website on a custom domain or on a custom subpath (e.g. `https://example.com/docs`). - Please reach out to the Fern team at support@buildwithfern.com to configure this. + Please reach out to the Fern team at [support@buildwithfern.com](mailto:support@buildwithfern.com) to configure this. - + + Fern supports integrations with a variety of providers such as PostHog, Segment, Intercom, Google Tag Manager, etc. Find out more on this [page](/learn/docs/integrations/overview). - - [View examples of documentation websites](https://buildwithfern.com/customers) that have been published using Fern. \ No newline at end of file