Skip to content

Commit 7d3528d

Browse files
authored
Merge pull request #10 from fern-api/devin/1779474903-graphql-example
feat: add GraphQL API Reference example
2 parents 34b8034 + 61acc99 commit 7d3528d

14 files changed

Lines changed: 345 additions & 0 deletions

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Example Fern docs projects. Each top-level folder is a self-contained example wi
99
| Example | Description | Live demo |
1010
| --- | --- | --- |
1111
| [`docs-starter`](./docs-starter) | Minimal starter project | [docs-starter.docs.buildwithfern.com](https://docs-starter.docs.buildwithfern.com) |
12+
| [`graphql`](./graphql) | GraphQL API Reference from a `.graphql` schema | [graphql.docs.buildwithfern.com](https://graphql.docs.buildwithfern.com) |
1213
| [`i18n`](./i18n) | Multi-language docs with English + Japanese translations | [i18n.docs.buildwithfern.com](https://i18n.docs.buildwithfern.com) |
1314
| [`multi-source`](./multi-source) | Multi-source docs — six independent projects publishing to one domain with global theme, nested sub-paths, and shared branding | [multi-source.docs.buildwithfern.com](https://multi-source.docs.buildwithfern.com) |
1415
| [`versioning`](./docs-versioned) | Versioned site with a version dropdown and a shared page | [versioning.docs.buildwithfern.com](https://versioning.docs.buildwithfern.com) |

graphql/fern/docs.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json
2+
3+
instances:
4+
- url: graphql.docs.buildwithfern.com
5+
6+
title: GraphQL Docs Example
7+
8+
layout:
9+
searchbar-placement: header
10+
page-width: full
11+
tabs-placement: header
12+
13+
tabs:
14+
home:
15+
display-name: Docs
16+
icon: home
17+
API Reference:
18+
display-name: API Reference
19+
icon: puzzle
20+
21+
navigation:
22+
- tab: home
23+
layout:
24+
- section: Get started
25+
contents:
26+
- page: Welcome
27+
path: docs/pages/welcome.mdx
28+
icon: fa-duotone fa-house
29+
- tab: API Reference
30+
layout:
31+
- section: Overview
32+
contents:
33+
- page: API reference
34+
path: docs/pages/api-reference-overview.mdx
35+
icon: fa-duotone fa-book
36+
- api: Plant Store GraphQL API
37+
38+
navbar-links:
39+
- type: minimal
40+
text: Fork this repo
41+
url: https://github.com/fern-api/docs-examples
42+
- type: filled
43+
text: Dashboard
44+
url: https://dashboard.buildwithfern.com
45+
- type: github
46+
value: https://github.com/fern-api/fern
47+
48+
colors:
49+
accent-primary:
50+
dark: "#70E155"
51+
light: "#008700"
52+
background:
53+
dark: "#111113"
54+
light: "#FFFFFF"
55+
56+
theme:
57+
page-actions: toolbar
58+
footer-nav: minimal
59+
60+
logo:
61+
dark: docs/assets/logo-dark.svg
62+
light: docs/assets/logo.svg
63+
height: 20
64+
href: https://buildwithfern.com
65+
66+
favicon: docs/assets/favicon.svg
67+
68+
css: styles.css
Lines changed: 8 additions & 0 deletions
Loading
Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 9 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)