Skip to content
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

docs: update removeOverview.mdx #58

Merged
merged 1 commit into from
Nov 27, 2024
Merged

docs: update removeOverview.mdx #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions src/content/docs/shared/removeoverview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@ title: RemoveOverview

import { FileTree } from '@astrojs/starlight/components';

:::note[April 30, 2024]
This component is only implemented in Melissa's local Web Monetization branch. If you need it added to another doc set, let HJ know.
:::

This component allows you to hide the *Overview* heading from a page's table of contents.

## Usage

Open the `PageSidebar.astro` file.

:::note
This component is added on a per-site basis. It's not technically a shared component that's part of `@interledger/docs-design-system`.

If you can't find `PageSidebar.astro`, it may not have been added to the site yet. Just let Sarah know.
:::

<FileTree>
- src
- components
Expand Down