Skip to content

Commit

Permalink
Merge branch 'main' into chdeskur/api-explorer
Browse files Browse the repository at this point in the history
  • Loading branch information
dannysheridan authored Jan 11, 2025
2 parents 6ae056c + ddd5c80 commit 47143d5
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions fern/pages/fern-docs/content/customize-api-ref.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,10 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T

<Tabs>
<Tab title="OpenAPI Specification">
```yaml title="docs.yml" {9-9}
```yaml title="docs.yml" {10}
navigation:
- api: API Reference
paginated: true
layout:
- user:
- endpoint: POST /user
Expand All @@ -161,9 +162,10 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
```
</Tab>
<Tab title="Fern Definition">
```yaml title="docs.yml" {9-9}
```yaml title="docs.yml" {10}
navigation:
- api: API Reference
paginated: true
layout:
- user:
- endpoint: user.create
Expand All @@ -175,6 +177,10 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
</Tab>
</Tabs>

<Tip title="Fully hidden endpoints">
For best results, API References with hidden endpoints should use the `paginated: true` configuration to avoid discovering endpoints from long-scrolling.
</Tip>

### Adding custom sections
You can add arbitrary folders in the sidebar by adding a `section` to your API Reference layout. A section can comprise entire groups of endpoints, individual endpoints, or even just Markdown pages. Sections can be customized by adding properties like a `icon`, `summary`, `slug` (or `skip-slug`), and `contents`.

Expand Down

0 comments on commit 47143d5

Please sign in to comment.