Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions fern/assets/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
appearance: none;
}

#builtwithfern {
display: none !important;
}

.motivation p {
max-width: unset !important;
}
Expand Down Expand Up @@ -283,11 +287,10 @@
left: -24px;
top: 0;
height: 100%;
width: 1.5rem;
width: 1rem;
opacity: 1;
pointer-events: none;
border-right: 1px solid var(--grayscale-5);
border-left: 1px solid var(--grayscale-5);
mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0 ) 100%);
-webkit-mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
}
Expand All @@ -297,21 +300,10 @@
right: -24px;
top: 0;
height: 100%;
width: 1.5rem;
width: 1rem;
opacity: 1;
pointer-events: none;
border-right: 1px solid var(--grayscale-5);
border-left: 1px solid var(--grayscale-5);
mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
-webkit-mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
}

.dashed-gradient {
height: 100%;
width: 100%;
background-image: url('data:image/svg+xml;utf8,<svg width="100" height="100" viewBox="0 0 100 100" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(%23clip0_351_76922)"><rect width="100" height="100" fill="transparent"/><path d="M0 100L100 -7.07537e-07" stroke="%23E0E1E6" stroke-width="4" stroke-linecap="round" stroke-linejoin="round"/></g><defs><clipPath id="clip0_351_76922"><rect width="100" height="100" fill="white"/></clipPath></defs></svg>');
background-repeat: repeat;
background-size: 12px 12px;
mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
-webkit-mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
}
Expand Down
46 changes: 31 additions & 15 deletions fern/footer-dist/output.js

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ paths:
client.users.get("user-1234")
```

If you're on the Fern Starter plan or higher for SDKs you won't have to worry about manually adding code samples! Our generators do that for you.
If you're on the Fern Basic plan or higher for SDKs you won't have to worry about manually adding code samples! Our generators do that for you.

## Availability

Expand Down
21 changes: 12 additions & 9 deletions fern/products/docs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ navigation:
- page: Setting up your domain
path: ./pages/getting-started/setting-up-your-domain.mdx
- link: Customer Showcase
href: https://buildwithfern.com/docs/getting-started/customers
href: https://buildwithfern.com/customers
- section: Component Library
contents:
- section: Writing Content
Expand Down Expand Up @@ -59,12 +59,10 @@ navigation:
path: ./pages/component-library/default-components/tabs.mdx
- page: Tooltips
path: ./pages/component-library/default-components/tooltips.mdx
- section: Custom Components
contents:
- page: Reusable Snippets
path: ./pages/component-library/custom-components/reusable-snippets.mdx
- page: Custom React Components
path: ./pages/component-library/custom-components/custom-react-components.mdx
- page: Reusable Snippets
path: ./pages/component-library/custom-components/reusable-snippets.mdx
- page: Custom React Components
path: ./pages/component-library/custom-components/custom-react-components.mdx
- section: Configuration
collapsed: true
contents:
Expand All @@ -79,8 +77,6 @@ navigation:
contents:
- page: Overview
path: ./pages/navigation/overview.mdx
- page: Tabs
path: ./pages/navigation/tabs.mdx
- page: Versions
path: ./pages/navigation/versions.mdx
- page: Products
Expand Down Expand Up @@ -136,10 +132,17 @@ navigation:
- section: Authentication
collapsed: true
contents:
- page: SSO
path: ./pages/authentication/sso.mdx
- page: RBAC
path: ./pages/authentication/rbac.mdx
- page: API Key Injection
path: ./pages/api-references/autopopulate-api-key.mdx
- section: Enterprise
collapsed: true
contents:
- page: Self-hosted
path: ./pages/enterprise/self-hosted.mdx
- section: Integrations
collapsed: true
contents:
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/api-references/sdk-snippets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ groups:

<Callout intent='info'>
SDK snippets automatically populated in your Fern Docs is a paid feature included
in the [SDK Starter plan](https://buildwithfern.com/pricing).
in the [SDK Basic plan](https://buildwithfern.com/pricing).
</Callout>

### Add the package name to your docs configuration
Expand Down
4 changes: 2 additions & 2 deletions fern/products/docs/pages/authentication/sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
title: Single Sign-On
---

How to configure Single Sign-On (SSO) for your documentation platform.
Fern supports SSO so that your docs site is gated for your team and customers.

<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview).</Warning>
<Warning>Docs are coming soon for this page.<br/><br/>Please [book a demo](https://buildwithfern.com/book-demo) or [reach out to us](https://buildwithfern.com/book-demo) to get set up with this feature. </Warning>
4 changes: 2 additions & 2 deletions fern/products/docs/pages/enterprise/self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
title: Self-hosted Enterprise
---

Information about self-hosted enterprise solutions for your documentation platform.
Fern supports self-hosting so that you can run your docs site on your own infrastructure.

<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview).</Warning>
<Warning>Docs are coming soon for this page.<br/><br/>Please [book a demo](https://buildwithfern.com/book-demo) or [reach out to us](https://buildwithfern.com/book-demo) to get set up with this feature. </Warning>
179 changes: 134 additions & 45 deletions fern/products/docs/pages/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,59 +8,148 @@ description: Meet documentation that is stunning by default, AI-ready, and desig
.fern-card {
text-decoration: none !important;
}

.docs-homepage {
position: relative;

.dashed-pattern-left {
position: absolute;
left: -4rem;
top: -8.5rem;
height: calc(100% + 26rem);
width: 1rem;
opacity: 1;
pointer-events: none;
border-right: 1px solid var(--grayscale-5);
mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0 ) 100%);
-webkit-mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
}

.dashed-pattern-right {
position: absolute;
right: -4rem;
top: -8.5rem;
height: calc(100% + 26rem);
width: 1rem;
opacity: 1;
pointer-events: none;
border-left: 1px solid var(--grayscale-5);
mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
-webkit-mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
}


.fern-card {
border: none !important;
padding: 0 !important;
box-shadow: none !important;
background-color: transparent !important;

.card-title {
display: flex;
gap: 0.25rem;
align-items: center;
}

img {
transition: transform 0.15s ease-in-out;
}

.arrow-right {
height: 1rem;
opacity: 0;
transition: opacity 0.15s ease-in-out, transform 0.15s ease-in-out;
transform: translateX(0px);
}

&:hover {
img {
transform: scale(1.01);
}

.arrow-right {
opacity: 1;
transform: translateX(2px);
}
}
}
}
`}
</style>

<CardGroup cols={2}>
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/guides/getting-started/quickstart">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Quickstart" src="./images/quickstart.png" />
<img class="mx-auto hidden dark:block" alt="Quickstart" src="./images/quickstart-dark.png" />
<div class="w-full space-y-1 overflow-hidden">
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold">Quickstart</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>Start building beautiful documentation in under 5 minutes.</p>
<div className="docs-homepage">
{/* Dashed Pattern - Left Side */}
<div className="dashed-pattern-left"></div>

{/* Dashed Pattern - Right Side */}
<div className="dashed-pattern-right"></div>
<CardGroup cols={2}>
<a class="fern-card interactive not-prose relative block p-6 text-base" href="/docs/guides/getting-started/quickstart">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Quickstart" src="./images/quickstart.png" />
<img class="mx-auto hidden dark:block" alt="Quickstart" src="./images/quickstart-dark.png" />
<div class="w-full space-y-1 overflow-hidden">
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
Quickstart
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>Start building beautiful documentation in under 5 minutes.</p>
</div>
</div>
</div>
</div>
</a>

<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/guides/getting-started/what-is-docs-yml">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Configure with ease" src="./images/configure.png" />
<img class="mx-auto hidden dark:block" alt="Configure with ease" src="./images/configure-dark.png" />
<div class="w-full space-y-1 overflow-hidden">
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold">Configure with ease</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>One simple file that can be used to generate documentation that fits your brand.</p>
</a>

<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/guides/getting-started/what-is-docs-yml">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Configure with ease" src="./images/configure.png" />
<img class="mx-auto hidden dark:block" alt="Configure with ease" src="./images/configure-dark.png" />
<div class="w-full space-y-1 overflow-hidden">
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
Configure with ease
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>One simple file that can be used to generate documentation that fits your brand.</p>
</div>
</div>
</div>
</div>
</a>

<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/component-library/overview">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Flexible component library" src="./images/component-library.png" />
<img class="mx-auto hidden dark:block" alt="Flexible component library" src="./images/component-library-dark.png" />
<div class="w-full space-y-1 overflow-hidden">
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold">Flexible component library</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>Use pre-built or custom React components for a polished look.</p>
</a>

<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/component-library/overview">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Flexible component library" src="./images/component-library.png" />
<img class="mx-auto hidden dark:block" alt="Flexible component library" src="./images/component-library-dark.png" />
<div class="w-full space-y-1 overflow-hidden">
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
Flexible component library
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>Use pre-built or custom React components for a polished look.</p>
</div>
</div>
</div>
</div>
</a>

<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/component-library/writing-content/visual-editor">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Visual Editor" src="./images/visual-editor.png" />
<img class="mx-auto hidden dark:block" alt="Visual Editor" src="./images/visual-editor-dark.png" />
<div class="w-full space-y-1 overflow-hidden">
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold">Visual Editor</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>Modify your documentation without touching code and publish to your GitHub.</p>
</a>

<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/component-library/writing-content/visual-editor">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Visual Editor" src="./images/visual-editor.png" />
<img class="mx-auto hidden dark:block" alt="Visual Editor" src="./images/visual-editor-dark.png" />
<div class="w-full space-y-1 overflow-hidden">
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
Visual Editor
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>Modify your documentation without touching code and publish to your GitHub.</p>
</div>
</div>
</div>
</div>
</a>
</CardGroup>
</a>
</CardGroup>
</div>
20 changes: 20 additions & 0 deletions fern/products/docs/pages/navigation/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,26 @@ navigation:
![Result of above docs.yml example](https://fern-image-hosting.s3.amazonaws.com/fern/nested-sections.png)
</Frame>

## Collapsed sections

You can set sections to be collapsed by default when the page loads by adding `collapsed: true` to a section.
This helps keep the navigation tidy when you have many sections or want to highlight the most important sections by keeping others collapsed.

```yaml {7} Example config with collapsed section
navigation:
- section: Getting Started
contents:
- page: Introduction
path: ./pages/intro.mdx
- section: Advanced Topics
collapsed: true
contents:
- page: Custom CSS
path: ./pages/advanced/css.mdx
- page: Analytics
path: ./pages/advanced/analytics.mdx
```

## Sidebar icons

For icons to appear next to sections and pages, add the `icon` key. The value should be a valid [Font Awesome icon](https://fontawesome.com/icons) name. Pro and Brand Icons from Font Awesome are supported.
Expand Down
Loading