Hide Page Actions

Control the visibility of page action links and buttons: Edit in GitHub, Log an issue, and Copy Markdown. Use these frontmatter options on a per-page basis when you want to hide one or more of these actions.

Overview

By default, documentation pages can show:

Use the options below to hide any of these actions for specific pages.

When to Use

Consider hiding these actions when:

You can hide any combination of the three; each option is independent.

Syntax

Add one or more properties to your page's frontmatter:

---
title: Your Page Title
hideEditInGitHub: true
hideLogIssue: true
hideCopyMarkDown: true
---

Parameters

Parameter
Type
Description
hideEditInGitHub
Boolean
When true, hides the "Edit in GitHub" link. Omit or false to show it (default).
hideLogIssue
Boolean
When true, hides the "Log an issue" button. Omit or false to show it (default).
hideCopyMarkDown
Boolean
When true, hides the "Copy Markdown" button. Omit or false to show it (default).

Examples

Hide only Edit in GitHub

---
title: Internal Reference
hideEditInGitHub: true
---

Hide only Log an issue

---
title: Feedback Page
hideLogIssue: true
---

Hide only Copy Markdown

---
title: Read-Only Page
hideCopyMarkDown: true
---

Hide all three actions

---
title: Locked Down Page
hideEditInGitHub: true
hideLogIssue: true
hideCopyMarkDown: true
---

Example

This page has all three options enabled. The "Edit in GitHub" link and the "Log an issue" and "Copy Markdown" buttons are not visible in the page action area.

Best Practices