Skip to content

Commit 136f5e6

Browse files
devin-ai-integration[bot]dannysheridandevalog
authored
docs: add page-actions configuration documentation (#1342)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: [email protected] <[email protected]> Co-authored-by: Devin Logan <[email protected]>
1 parent f5f916d commit 136f5e6

File tree

2 files changed

+50
-7
lines changed

2 files changed

+50
-7
lines changed

fern/products/docs/pages/component-library/custom-components/custom-css-js.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,13 @@ to display.
6666
6767
<CodeBlock title="styles.css">
6868
```css
69-
.fern-page-actions {
69+
.fern-layout-footer-toolbar { # Hides Fern feedback widget
7070
display: none !important;
7171
}
7272
```
7373
</CodeBlock>
7474

75-
Commonly hidden components include `.fern-page-actions` (**Open in
76-
ChatGPT**, **Open in Claude**, and **Copy Page** buttons) and `.fern-layout-footer-toolbar`
77-
(Fern feedback widget). You can target other Fern UI components using their CSS class names. Use your browser's developer tools to inspect elements and find their class names.
75+
You can target other Fern UI components using their CSS class names. Use your browser's developer tools to inspect elements and find their class names.
7876
</Accordion>
7977
<Accordion title="Adding custom styling">
8078

fern/products/docs/pages/customization/what-is-docs-yml.mdx

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -510,16 +510,16 @@ layout:
510510
</ParamField>
511511

512512
<ParamField path="layout.disable-header" type="boolean" required={false} default="false" toc={true}>
513-
If set to true, the header will not be rendered. Instead, the logo will be rendered as part of the sidebar,
513+
If set to true, the header won't be rendered. Instead, the logo will be rendered as part of the sidebar,
514514
and a 1px border will separate the sidebar from the content.
515515
</ParamField>
516516

517517
<ParamField path="layout.hide-nav-links" type="boolean" required={false} default="false" toc={true}>
518-
If set to true, the navigation links (previous, next) at the bottom of the page will not be rendered. This can be overridden on a per-page basis using the [frontmatter](/learn/docs/configuration/page-level-settings#navigation-links).
518+
If set to true, the navigation links (previous, next) at the bottom of the page won't be rendered. This can be overridden on a per-page basis using the [frontmatter](/learn/docs/configuration/page-level-settings#navigation-links).
519519
</ParamField>
520520

521521
<ParamField path="layout.hide-feedback" type="boolean" required={false} default="false" toc={true}>
522-
If set to true, the feedback form will not be rendered. This can be overridden on a per-page basis using the [frontmatter](/learn/docs/configuration/page-level-settings#on-page-feedback).
522+
If set to true, the feedback form won't be rendered. This can be overridden on a per-page basis using the [frontmatter](/learn/docs/configuration/page-level-settings#on-page-feedback).
523523
</ParamField>
524524

525525
## Settings configuration
@@ -578,6 +578,51 @@ settings:
578578
If set to true, the TypeScript snippets will be displayed as JavaScript snippets in the API Reference.
579579
</ParamField>
580580

581+
## Page actions configuration
582+
583+
Configure the page action buttons that appear throughout your documentation. By default, **Copy Page** (`copy-page`), **View as Markdown** (`view-as-markdown`), and **Ask AI** (`ask-ai`) are enabled.
584+
585+
```yaml docs.yml
586+
page-actions:
587+
default: copy-page
588+
options:
589+
copy-page: false
590+
ask-ai: false
591+
cursor: true
592+
```
593+
594+
<ParamField path="page-actions.default" type="string" required={false} toc={true}>
595+
The default page action to display. Options: `copy-page`, `view-as-markdown`, `ask-ai`, `chatgpt`, `claude`, `cursor`, `vscode`.
596+
</ParamField>
597+
598+
<ParamField path="page-actions.options.copy-page" type="boolean" required={false} default="true" toc={true}>
599+
When enabled, displays a button that allows users to copy the entire page content to their clipboard for easy sharing or reference.
600+
</ParamField>
601+
602+
<ParamField path="page-actions.options.view-as-markdown" type="boolean" required={false} default="true" toc={true}>
603+
When enabled, displays a button that allows users to view the raw Markdown source of the current page.
604+
</ParamField>
605+
606+
<ParamField path="page-actions.options.ask-ai" type="boolean" required={false} default="true" toc={true}>
607+
When enabled, displays an "Ask AI" button that allows users to ask questions about the page content using AI-powered assistance.
608+
</ParamField>
609+
610+
<ParamField path="page-actions.options.chatgpt" type="boolean" required={false} default="false" toc={true}>
611+
When enabled, displays an "Open in ChatGPT" button that allows users to send the page content to ChatGPT for further exploration and Q&A.
612+
</ParamField>
613+
614+
<ParamField path="page-actions.options.claude" type="boolean" required={false} default="false" toc={true}>
615+
When enabled, displays an "Open in Claude" button that allows users to send the page content to Claude for further exploration and Q&A.
616+
</ParamField>
617+
618+
<ParamField path="page-actions.options.cursor" type="boolean" required={false} default="false" toc={true}>
619+
When enabled, displays an "Open in Cursor" button that allows users to open the page content in Cursor IDE with AI-powered code assistance.
620+
</ParamField>
621+
622+
<ParamField path="page-actions.options.vscode" type="boolean" required={false} default="false" toc={true}>
623+
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.
624+
</ParamField>
625+
581626
## GitHub configuration
582627

583628
<Tabs>

0 commit comments

Comments
 (0)