Skip to content

Commit 02c3bfb

Browse files
authored
Merge pull request #61 from AdobeDocs/DEVSITE-2416
update instruction for noToc to hide ON THIS PAGE
2 parents f6b004d + e5b1f8d commit 02c3bfb

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

src/pages/blocks/page-actions/index.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ By default, documentation pages can show:
1616
- **Edit in GitHub**: Link to open the source file on GitHub and propose edits
1717
- **Log an issue**: Button to report a problem with the page (GitHub or your issue tracker)
1818
- **Copy as Markdown**: Button to copy the page content as Markdown
19+
- **ON THIS PAGE**: Sidebar navigation generated from the page's headings
1920

2021
## When to Hide
2122

@@ -24,18 +25,20 @@ Consider hiding these actions when:
2425
- **Edit in GitHub**: Restricted content, auto-generated pages, sensitive docs, legal/compliance pages, or content that requires internal review before edits
2526
- **Log an issue**: Pages not open for public feedback, auto-generated content, or internal-only docs where issues are handled elsewhere
2627
- **Copy as Markdown**: Pages where copying source is restricted, sensitive content, or minimal layouts where you want less clutter
28+
- **ON THIS PAGE**: Pages with no meaningful heading structure, single-section pages, or layouts where the sidebar adds visual clutter
2729

2830

2931

3032
## How to hide
31-
To hide one or more of these actions on a page, add the corresponding options to that pages frontmatter. Each option is independent, so you can combine them as needed.
33+
To hide one or more of these actions on a page, add the corresponding options to that page's frontmatter. Each option is independent, so you can combine them as needed.
3234

3335
```yaml
3436
---
3537
title: Your Page Title
3638
hideEditInGitHub: true
3739
hideLogIssue: true
3840
hideCopyMarkdown: true
41+
hideOnThisPage: true
3942
---
4043
```
4144

@@ -46,6 +49,7 @@ hideCopyMarkdown: true
4649
| **hideEditInGitHub** | Boolean | When `true`, hides the "Edit in GitHub" link. Omit or `false` to show it (default). |
4750
| **hideLogIssue** | Boolean | When `true`, hides the "Log an issue" button. Omit or `false` to show it (default). |
4851
| **hideCopyMarkdown** | Boolean | When `true`, hides the "Copy as Markdown" button. Omit or `false` to show it (default). |
52+
| **hideOnThisPage** | Boolean | When `true`, hides the "ON THIS PAGE" sidebar navigation. Omit or `false` to show it (default). |
4953

5054
## Examples
5155

@@ -76,14 +80,24 @@ hideCopyMarkdown: true
7680
---
7781
```
7882

79-
### Hide all three actions
83+
### Hide the ON THIS PAGE sidebar
84+
85+
```yaml
86+
---
87+
title: Single-Section Page
88+
hideOnThisPage: true
89+
---
90+
```
91+
92+
### Hide all actions
8093

8194
```yaml
8295
---
8396
title: Locked Down Page
8497
hideEditInGitHub: true
8598
hideLogIssue: true
8699
hideCopyMarkdown: true
100+
hideOnThisPage: true
87101
---
88102
```
89103

0 commit comments

Comments
 (0)