Skip to content

docs: add theme configuration section to docs.yml page #1878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+27 −0
Open

docs: add theme configuration section to docs.yml page #1878

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9864a2a
docs: add theme configuration section to docs.yml page
devin-ai-integration[bot] Nov 9, 2025
930bd34
Update docs.yml
chdeskur Nov 10, 2025
6242afd
Update fern.config.json
chdeskur Nov 10, 2025
d41d1ac
Update fern.config.json
chdeskur Nov 10, 2025
2ea2c9b
Merge branch 'main' of https://github.com/fern-api/docs into devin/17…
devalog Nov 10, 2025
81e9391
make intro more concise
devalog Nov 10, 2025
2068d55
docs: update theme configuration to only include page-actions and foo…
devin-ai-integration[bot] Nov 12, 2025
c1423d6
Merge main into feature branch to resolve conflicts
devin-ai-integration[bot] Nov 12, 2025
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
3 changes: 3 additions & 0 deletions fern/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ layout:
searchbar-placement: header
tabs-placement: header

theme:
page-actions: toolbar

settings:
http-snippets:
- curl
Expand Down
4 changes: 2 additions & 2 deletions fern/fern.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"organization": "fern",
"version": "0.107.3"
}
"version": "0.113.1"
}
40 changes: 40 additions & 0 deletions fern/products/docs/pages/customization/site-level-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -683,6 +683,46 @@ page-actions:
When enabled, displays an "Open in VS Code" button that allows users to open the page content in Visual Studio Code for editing and development.
</ParamField>

## Theme configuration

Configure the visual styling of various documentation elements throughout your site.

```yaml docs.yml
theme:
page-actions: toolbar
sidebar: minimal
body: canvas
tabs: bubble
```

<ParamField path="theme.page-actions" type="enum" required={false} toc={true}>
Controls the visual style of page action buttons. Options:

- `default`: Standard page actions appearance with buttons displayed in the default style
- `toolbar`: Toolbar-style appearance that displays page actions in a more compact, toolbar-like format
</ParamField>

<ParamField path="theme.sidebar" type="enum" required={false} toc={true}>
Controls the visual style of the sidebar navigation. Options:

- `default`: Standard sidebar appearance
- `minimal`: Minimalist sidebar style with reduced visual elements
</ParamField>

<ParamField path="theme.body" type="enum" required={false} toc={true}>
Controls the visual style of the main content body. Options:

- `default`: Standard body appearance
- `canvas`: Canvas-style appearance with a distinct visual treatment
</ParamField>

<ParamField path="theme.tabs" type="enum" required={false} toc={true}>
Controls the visual style of tab navigation elements. Options:

- `default`: Standard tab appearance
- `bubble`: Bubble-style tabs with rounded, pill-shaped buttons
</ParamField>

## GitHub configuration

<Tabs>
Expand Down