Entries
Display a grouped directory listing of documentation pages
Displays all documentation entries in a multi-column layout, grouped by category.
The Entries component automatically generates a directory listing of all documentation pages in the site, organized by their top-level category (first segment of the slug).
<Entries />
result:
authoring
- Backers
- Code
- Codesandbox
- Contributors
- Entries
- Gha
- Grid
- Hint (Deprecated)
- Img
- Intro
- Authoring
- Keypoints
- Mermaid
- Sandpack
github-actions
CodeSandbox integration
When a documentation page includes a CodeSandbox component, the Entries listing will automatically display a CodeSandbox icon next to that page's link. For example, this page includes:
<Codesandbox id="5w35n6" />
result:
SSGI spheres with rapier physics
This means this page will appear in the Entries listing with a CodeSandbox icon.
Excluding categories
You can exclude specific categories from the listing using the excludedGroups prop:
<Entries excludedGroups={['getting-started', 'tutorials']} />
By default, the getting-started category is excluded from the listing to keep the directory focused on reference documentation.
How it works
The component:
- Groups all documentation pages by their first slug segment (category)
- Displays categories in alphabetical order with capitalized headings
- Shows each page's title as a clickable link
- Includes CodeSandbox icons next to pages that contain CodeSandbox examples
- Renders in a responsive multi-column layout (2 columns on mobile, 3 on desktop)