diff --git a/fern/products/docs/pages/getting-started/overview.mdx b/fern/products/docs/pages/getting-started/overview.mdx index 0c010c2d2..8d333869e 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/quickstart.mdx b/fern/products/docs/pages/getting-started/quickstart.mdx index a53c14f77..cffc9638d 100644 --- a/fern/products/docs/pages/getting-started/quickstart.mdx +++ b/fern/products/docs/pages/getting-started/quickstart.mdx @@ -11,79 +11,82 @@ 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). + + Get started by cloning the [starter template](https://github.com/fern-api/docs-starter). - - ```bash title="SSH" - git clone git@github.com:fern-api/docs-starter.git - ``` - ```bash title="HTTPS" - git clone https://github.com/fern-api/docs-starter.git - ``` - + + ```bash title="SSH" + git clone git@github.com:fern-api/docs-starter.git + ``` - Next, please update the template settings to use your organization. + ```bash title="HTTPS" + git clone https://github.com/fern-api/docs-starter.git + ``` + + + 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} + + + ```json {2} { "organization": "{{YOUR_ORGANIZATION}}", "version": "0.x.x" } ``` - - - ```yml {2} + + + + ```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 + Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation: - ```bash - npm install -g fern-api - ``` + ```bash + fern generate --docs + ``` + - Then run + + If you prefer, you can use our CLI to create a new project. Install the CLI by running - ```bash - fern init --docs - ``` + ```bash + npm install -g fern-api + ``` - You will see a new `fern` folder in your project with the following structure: + Then run - ```bash - fern - ├─ 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 init --docs + ``` - ```bash - fern generate --docs - ``` - + You will see a new `fern` folder in your project with the following structure: + + ```bash + fern + ├─ 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 + ``` + @@ -91,61 +94,61 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it - [here](https://buildwithfern.com/contact). + [here](https://buildwithfern.com/contact). + - - Add content with MDX files. - - ```markdown - --- - title: "Page Title" - description: "Subtitle (optional)" - --- - - Hello world! - ``` + + Add content with MDX files. - + ```markdown + --- + title: "Page Title" + description: "Subtitle (optional)" + --- + + Hello world! + ``` + + 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 - - section: Overview - contents: - - page: QuickStart - path: docs/pages/hello-world.mdx - ``` - - - Add an API Reference by adding an OpenAPI Specification to your project. + ``` + navigation: + - page: Hello World + path: docs/pages/hello-world.mdx + - section: Overview + contents: + - page: QuickStart + path: docs/pages/hello-world.mdx + ``` + - ```bash - fern init --openapi /path/to/openapi.yml - ``` + + Add an API Reference by adding an OpenAPI Specification to your project. - 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. + ```bash + fern init --openapi /path/to/openapi.yml + ``` - ```yml - navigation: - - api: "API Reference" - ``` - - - All of the branding for your docs can be configured in the `docs.yml` file. + 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. + + ``` + navigation: + - api: "API Reference" + ``` + - For example, to set the logos, colors, and fonts for your docs, you can - add the following to your `docs.yml` file: + + 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: + + ```yml colors: accent-primary: @@ -160,44 +163,63 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. 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). + + + + + - Item one + + - Item two + + - Item three + + ```javascript + function test() { + console.log("HELLO WORLD"); + } + ``` - + ### Publish to production - - When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI. + + 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 - custom subpath (e.g. `https://example.com/docs`). + [Read more.](/learn/docs/preview-publish/publishing-your-docs) + - Please reach out to the Fern team at 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). - + + 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. + + + 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 + +[View examples of documentation websites](https://buildwithfern.com/customers) that have been published using Fern. diff --git a/fern/products/home/pages/welcome.mdx b/fern/products/home/pages/welcome.mdx index c46356dda..54e6efcf0 100644 --- a/fern/products/home/pages/welcome.mdx +++ b/fern/products/home/pages/welcome.mdx @@ -1,12 +1,11 @@ --- title: Build with Fern -description: Explore our guides for how to generate SDKs and Docs with Fern. slug: / +description: Explore our guides for how to generate SDKs and Docs with Fern. hide-toc: true layout: custom --- - import { FernFooter } from "../../../components/FernFooter";
@@ -389,4 +388,4 @@ import { FernFooter } from "../../../components/FernFooter";
- \ No newline at end of file +