Skip to content

Commit 646ece1

Browse files
Visual Editor: Update
1 parent 755710e commit 646ece1

File tree

3 files changed

+66
-67
lines changed

3 files changed

+66
-67
lines changed

fern/products/docs/pages/getting-started/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,4 +155,4 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
155155
</div>
156156
</a>
157157
</CardGroup>
158-
</div>
158+
</div>

fern/products/docs/pages/getting-started/project-structure.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ The `pages` folder is organized into subfolders based on the sections of your do
5353

5454
The `assets` folder contains any images or videos used in your documentation. You can reference these assets in your MDX files using relative paths.
5555

56+
Hellooo this is deep!!
57+
5658
<CodeBlock title="fern/assets">
5759
```bash
5860
assets
@@ -166,11 +168,11 @@ title: Fern's Documentation
166168
</AccordionGroup>
167169

168170
<Note>
169-
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.
171+
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.
170172

171173
If you're only using Fern for API Reference docs, not SDKs, your `generators.yml` should simply link to your spec:
172174

173-
```yaml title="generators.yml"
175+
```yaml
174176
api:
175177
specs:
176178
- openapi: ../openapi/openapi.json
@@ -189,6 +191,4 @@ The `fern.config.json` file specifies your organization name and the version of
189191
"version": "<Markdown src="/snippets/version-number-cli.mdx"/>"
190192
}
191193
```
192-
</CodeBlock>
193-
194-
194+
</CodeBlock>

fern/products/docs/pages/getting-started/quickstart.mdx

Lines changed: 60 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
1111

1212
<Steps toc={true}>
1313
### Initialize your `fern` folder
14-
15-
All the configurations for your docs live in the `fern` folder. Inside, you'll
16-
find a `docs.yml` file that contains all the settings for your documentation.
14+
15+
All the configurations for your docs live in the `fern` folder. Inside, you'll
16+
find a `docs.yml` file that contains all the settings for your documentation.
1717

1818
<AccordionGroup toc={true}>
19-
<Accordion title='Clone the starter repository'>
19+
<Accordion title="Clone the starter repository">
2020
Get started by cloning the [starter template](https://github.com/fern-api/docs-starter).
2121

2222
<CodeBlocks>
@@ -31,35 +31,35 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
3131
Next, please update the template settings to use your organization.
3232

3333
<Warning title="Edit template settings">
34-
Please edit the details `fern.config.json` and `docs.yml` with your organization
35-
name.
34+
Please edit the details `fern.config.json` and `docs.yml` with your organization name.
3635

3736
<CodeBlocks>
3837
<CodeBlock title="fern.config.json">
39-
```json {2}
40-
{
41-
"organization": "{{YOUR_ORGANIZATION}}",
42-
"version": "0.x.x"
43-
}
44-
```
38+
```json {2}
39+
{
40+
"organization": "{{YOUR_ORGANIZATION}}",
41+
"version": "0.x.x"
42+
}
43+
```
4544
</CodeBlock>
4645
<CodeBlock title="docs.yml">
47-
```yml {2}
48-
instances:
49-
- url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com
50-
```
46+
```yml {2}
47+
instances:
48+
- url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com
49+
```
5150
</CodeBlock>
5251
</CodeBlocks>
5352
</Warning>
53+
5454
Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation:
5555

5656
```bash
5757
fern generate --docs
5858
```
5959
</Accordion>
60-
<Accordion title='Use the Fern CLI'>
61-
If you prefer, you can use our CLI to create a new project. Install the CLI
62-
by running
60+
61+
<Accordion title="Use the Fern CLI">
62+
If you prefer, you can use our CLI to create a new project. Install the CLI by running
6363

6464
```bash
6565
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.
7878
├─ docs.yml
7979
└─ fern.config.json
8080
```
81+
8182
Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation:
8283

8384
```bash
8485
fern generate --docs
8586
```
8687
</Accordion>
87-
8888
</AccordionGroup>
8989

9090
### Update your docs
@@ -95,9 +95,9 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
9595
</Note>
9696

9797
<AccordionGroup toc={true}>
98-
<Accordion title='Add content' >
99-
Add content with MDX files.
100-
98+
<Accordion title="Add content">
99+
Add content with MDX files.
100+
101101
```markdown
102102
---
103103
title: "Page Title"
@@ -108,13 +108,12 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
108108
```
109109

110110
<Note title="Supported Syntax">
111-
Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required.
111+
Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required.
112112
</Note>
113113

114-
In order for the Markdown page to show up, you'll need to reference them from your `docs.yml` file. You
115-
can reference the Markdown page within a section or as a standalone page.
114+
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.
116115

117-
```yml
116+
```
118117
navigation:
119118
- page: Hello World
120119
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.
124123
path: docs/pages/hello-world.mdx
125124
```
126125
</Accordion>
127-
<Accordion title='Add an API Reference' >
126+
127+
<Accordion title="Add an API Reference">
128128
Add an API Reference by adding an OpenAPI Specification to your project.
129129

130130
```bash
131131
fern init --openapi /path/to/openapi.yml
132132
```
133133

134-
This will create an `openapi.yml` file in your project. You can reference this file in your
135-
`docs.yml` file by adding an api block.
134+
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.
136135

137-
```yml
136+
```
138137
navigation:
139138
- api: "API Reference"
140139
```
141140
</Accordion>
142-
<Accordion title='Brand your docs'>
141+
142+
<Accordion title="Brand your docs">
143143
All of the branding for your docs can be configured in the `docs.yml` file.
144144

145-
For example, to set the logos, colors, and fonts for your docs, you can
146-
add the following to your `docs.yml` file:
145+
For example, to set the logos, colors, and fonts for your docs, you can add the following to your `docs.yml` file:
147146

148147
<CodeBlock title="docs.yml">
149-
```yml
150-
colors:
151-
accent-primary:
152-
dark: "#f0c193"
153-
light: "#af5f1b"
154-
155-
logo:
156-
dark: docs/assets/logo-dark.svg
157-
light: docs/assets/logo-light.svg
158-
height: 40
159-
href: https://buildwithfern.com/
160-
161-
favicon: docs/assets/favicon.svg
162-
```
148+
```yml
149+
colors:
150+
accent-primary:
151+
dark: "#f0c193"
152+
light: "#af5f1b"
153+
154+
logo:
155+
dark: docs/assets/logo-dark.svg
156+
light: docs/assets/logo-light.svg
157+
height: 40
158+
href: https://buildwithfern.com/
159+
160+
favicon: docs/assets/favicon.svg
161+
```
163162
</CodeBlock>
164-
165163
</Accordion>
166-
167164
</AccordionGroup>
168-
165+
169166
### Preview your docs
167+
170168
<AccordionGroup toc={true}>
171-
<Accordion title='Preview your docs locally'>
169+
<Accordion title="Preview your docs locally">
172170
You can preview your docs locally for testing purposes by following the instructions [here](/docs/preview-publish/previewing-changes-locally).
173171
</Accordion>
174-
<Accordion title='Preview your docs in a PR'>
172+
173+
<Accordion title="Preview your docs in a PR">
175174
`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).
176175
</Accordion>
177176
</AccordionGroup>
178-
177+
179178
### Publish to production
180179

181180
<AccordionGroup toc={true}>
182-
<Accordion title='Publishing your docs'>
181+
<Accordion title="Publishing your docs">
183182
When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI.
184183

185184
[Read more.](/learn/docs/preview-publish/publishing-your-docs)
186185
</Accordion>
187-
<Accordion title='Host on a custom domain'>
188-
Fern supports hosting your docs website on a custom domain or on a
186+
187+
<Accordion title="Host on a custom domain">
188+
Fern supports hosting your docs website on a custom domain or on a
189189
custom subpath (e.g. `https://example.com/docs`).
190190

191-
Please reach out to the Fern team at [email protected] to configure this.
191+
Please reach out to the Fern team at [[email protected]](mailto:[email protected]) to configure this.
192192
</Accordion>
193-
<Accordion title='Configure analytics'>
193+
194+
<Accordion title="Configure analytics">
194195
Fern supports integrations with a variety of providers such as PostHog, Segment, Intercom,
195196
Google Tag Manager, etc.
196197
Find out more on this [page](/learn/docs/integrations/overview).
197198
</Accordion>
198-
199199
</AccordionGroup>
200-
201200
</Steps>
202201

203202
[View examples of documentation websites](https://buildwithfern.com/customers) that have been published using Fern.

0 commit comments

Comments
 (0)