Skip to content

Commit 04c4c53

Browse files
authored
feat(docs): add icons, font, styling (#4423)
1 parent c270347 commit 04c4c53

32 files changed

+193
-132
lines changed
27.5 KB
Binary file not shown.

fern/assets/GT-Planar-Bold.woff2

9.41 KB
Binary file not shown.

fern/assets/GT-Planar.woff2

9.51 KB
Binary file not shown.

fern/docs.yml

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,23 @@ title: Fern
1717
tabs:
1818
home:
1919
display-name: Home
20+
icon: fa-regular fa-home
2021
slug: home
2122
api-definition:
2223
display-name: API Definition
24+
icon: fa-regular fa-book
2325
slug: api-definition
2426
docs:
2527
display-name: Docs
28+
icon: fa-regular fa-browser
2629
slug: docs
2730
sdks:
2831
display-name: SDKs
32+
icon: fa-brands fa-codepen
2933
slug: sdks
3034
cli-api:
3135
display-name: CLI & API Reference
36+
icon: fa-regular fa-code
3237
slug: cli-api
3338

3439
css: ./assets/styles.css
@@ -240,46 +245,60 @@ navigation:
240245
- section: Building Your Docs
241246
contents:
242247
- page: Navigation
248+
icon: fa-regular fa-compass
243249
path: ./pages/docs/building-your-docs/navigation.mdx
244250
- page: Custom CSS & Global JS
251+
icon: fa-regular fa-paintbrush
245252
path: ./pages/docs/building-your-docs/custom-css-js.mdx
246253
- page: Pull Request Preview
254+
icon: fa-regular fa-file-magnifying-glass
247255
path: ./pages/docs/building-your-docs/pr-preview.mdx
248256
- page: Custom Domain
257+
icon: fa-regular fa-globe-pointer
249258
path: ./pages/docs/building-your-docs/custom-domain.mdx
250259

251260
- section: Writing Content
252261
slug: content
253262
contents:
254263
- page: Write Markdown content
264+
icon: fa-regular fa-font
255265
path: ./pages/fern-docs/content/write-markdown.mdx
256266
slug: write-markdown
257267
- page: Frontmatter
268+
icon: fa-regular fa-sliders
258269
path: ./pages/fern-docs/content/front-matter.mdx
259270
- page: Reusable snippets
271+
icon: fa-regular fa-recycle
260272
path: ./pages/fern-docs/content/reusable-snippets.mdx
261273

262274
- section: API References
263275
contents:
264276
- page: Generate API reference
277+
icon: fa-regular fa-gear-code
265278
path: ./pages/fern-docs/content/generate-api-ref.mdx
266279
slug: generate-api-ref
267280
- page: SDK snippets
281+
icon: fa-regular fa-message-code
268282
path: ./pages/fern-docs/config/sdk-snippets.mdx
269283
- page: Endpoint errors
284+
icon: fa-regular fa-exclamation-triangle
270285
path: ./pages/fern-docs/config/endpoint-errors.mdx
271286
- page: Reorder API Reference pages
287+
icon: fa-regular fa-arrow-up-arrow-down
272288
path: ./pages/fern-docs/content/reorder-api-ref.mdx
273289
- page: Write markdown in API Reference
290+
icon: fa-regular fa-pencil
274291
path: ./pages/fern-docs/content/api-ref-content.mdx
275292

276293
- section: Integrations
277294
slug: integrations
278295
contents:
279296
- page: Overview
297+
icon: fa-regular fa-link
280298
slug: overview
281299
path: ./pages/docs/integrations/overview.mdx
282300
- section: Analytics
301+
icon: fa-regular fa-chart-simple
283302
slug: analytics
284303
contents:
285304
- page: PostHog
@@ -289,6 +308,7 @@ navigation:
289308
- page: Segment
290309
path: ./pages/docs/integrations/analytics/segment.mdx
291310
- section: Support
311+
icon: fa-regular fa-headset
292312
slug: support
293313
contents:
294314
- page: Intercom
@@ -302,14 +322,17 @@ navigation:
302322
contents:
303323
- page: GitLab
304324
slug: gitlab
325+
icon: fa-brands fa-gitlab
305326
path: ./pages/docs/developer-tools/gitlab.mdx
306327
- page: Vale
328+
icon: fa-regular fa-list-check
307329
path: ./pages/docs/developer-tools/vale.mdx
308330

309331
- section: Components
310332
slug: components
311333
contents:
312-
- page: Overview
334+
- page: Overview
335+
icon: fa-regular fa-toolbox
313336
path: ./pages/docs/components/overview.mdx
314337
- page: Accordions
315338
path: ./pages/docs/components/accordions.mdx
@@ -341,7 +364,7 @@ navigation:
341364
icon: "rectangle-code"
342365
- page: Steps
343366
path: ./pages/docs/components/steps.mdx
344-
icon: "arrow-fa-regular fa-progress"
367+
icon: "fa-solid fa-arrow-progress"
345368
slug: steps
346369
- page: Frames
347370
path: ./pages/docs/components/frames.mdx
@@ -390,6 +413,15 @@ navbar-links:
390413
- type: filled
391414
text: Book a demo
392415
url: https://buildwithfern.com/contact
416+
417+
typography:
418+
bodyFont:
419+
name: GT-Planar
420+
path: ./assets/GT-Planar.woff2
421+
weight: 400
422+
headingsFont:
423+
name: GT-Planar
424+
path: ./assets/GT-Planar-Bold.woff2
393425

394426
logo:
395427
href: https://www.buildwithfern.com
@@ -405,6 +437,9 @@ colors:
405437
background:
406438
dark: "#081008"
407439
light: "#FBFFFA"
440+
header-background:
441+
dark: "#081008"
442+
light: "#FBFFFA"
408443
favicon: ./images/favicon.ico
409444

410445
layout:

fern/pages/api-definition/fern-definition/api-yml/overview.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ description: The api.yml file contains general API configuration when using the
55

66
A `fern/` folder has a special file called `api.yml`, which includes all the API-wide configuration.
77

8-
```yaml
8+
```bash {5}
99
fern/
1010
├─ fern.config.json
1111
├─ generators.yml
1212
└─ definition/
13-
├─ api.yml # <---
13+
├─ api.yml
1414
├─ pet.yml
1515
├─ store.yml
1616
└─ user.yml
@@ -31,9 +31,9 @@ name: api
3131
You can define a top level API description. This description will come through in the OpenAPI spec and Postman collection.
3232
3333
<CodeBlock title="api.yml">
34-
```yaml
34+
```yaml {2-4}
3535
name: api
36-
docs: | # <---
36+
docs: |
3737
## Header
3838
This API provides access to...
3939
```

fern/pages/api-definition/fern-definition/availability.mdx

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ Availability can be:
1414
## Endpoint
1515

1616
<CodeBlock title="pet.yml">
17-
```diff
17+
```yaml {6}
1818
service:
1919
base-path: /pet
2020
auth: true
2121
endpoints:
2222
add:
23-
+ availability: deprecated
23+
availability: deprecated
2424
display-name: Add pet
2525
docs: Add a new Pet to the store
2626
method: POST
@@ -31,12 +31,15 @@ service:
3131
</CodeBlock>
3232
3333
In Fern Docs, this will look like:
34+
35+
<Frame>
3436
![Screenshot showing a deprecated tag next to an endpoint in API Reference docs](https://fern-image-hosting.s3.amazonaws.com/endpoint-deprecated.png)
37+
</Frame>
3538
3639
## Type
3740
3841
<CodeBlock title="pet.yml">
39-
```diff
42+
```yaml {15}
4043
Pet:
4144
properties:
4245
id:
@@ -51,7 +54,7 @@ In Fern Docs, this will look like:
5154
availability: generally-available
5255
category:
5356
type: optional<Category>
54-
+ availability: pre-release
57+
availability: pre-release
5558

5659
Category:
5760
properties:
@@ -61,12 +64,15 @@ In Fern Docs, this will look like:
6164
</CodeBlock>
6265
6366
In Fern Docs, this will look like:
67+
68+
<Frame>
6469
![Screenshot showing a beta tag next to a type in API Reference docs](https://fern-image-hosting.s3.amazonaws.com/type-beta.png)
70+
</Frame>
6571
6672
## Property
6773
6874
<CodeBlock title="pet.yml">
69-
```diff
75+
```yaml {12}
7076
Pet:
7177
properties:
7278
id:
@@ -78,10 +84,13 @@ In Fern Docs, this will look like:
7884
photoUrls:
7985
type: list<string>
8086
docs: A list of publicly available URLs featuring the Pet
81-
+ availability: deprecated
87+
availability: deprecated
8288
category: optional<Category>
8389
```
8490
</CodeBlock>
8591
8692
In Fern Docs, this will look like:
93+
94+
<Frame>
8795
![Screenshot showing a deprecated tag next to a type's property in API Reference docs](https://fern-image-hosting.s3.amazonaws.com/property-deprecated.png)
96+
</Frame>

fern/pages/api-definition/fern-definition/depending-on-other-apis.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ $ fern register
2626
To add a dependency on another API, you must add a `dependencies.yml` to declare which
2727
APIs you wish to depend on.
2828

29-
```yaml {4}
29+
```bash {4}
3030
fern/
3131
├─ fern.config.json
3232
├─ generators.yml
@@ -46,7 +46,7 @@ dependencies:
4646
Next, you need create a folder in your Fern Definition to house the dependency. Inside the folder, create a special file
4747
`__package__.yml` which specifies the dependency and version you want to add.
4848

49-
```yaml {8-9}
49+
```bash {8-9}
5050
fern/
5151
├─ fern.config.json
5252
├─ generators.yml

0 commit comments

Comments
 (0)