Skip to content
Cloudflare Docs

Directory listing

Use <DirectoryListing /> to display the directory of a specific folder, which appears as a list of links.

Usage

Default


maxDepth

Descriptions

  • API : A set of programmatic APIs that can be integrated with local Cloudflare Workers-related workflows.
  • Bundling : Review Wrangler's default bundling.
  • Commands : Create, develop, and deploy your Cloudflare Workers with Wrangler commands.
  • Configuration : Use a configuration file to customize the development and deployment setup for your Worker project and other Developer Platform products.
  • Custom builds : Customize how your code is compiled, before being processed by Wrangler.
  • Deprecations : The differences between Wrangler versions, specifically deprecations and breaking changes.
  • Environments : Use environments to create different configurations for the same Worker application.
  • System environment variables : Local environment variables that can change Wrangler's behavior.
  • Install/Update Wrangler : Get started by installing Wrangler, and update to newer versions by following this guide.
  • Migrations : Review migration guides for specific versions of Wrangler. 
import { DirectoryListing } from "~/components";


<p>
  <strong>Default</strong>
</p>
<DirectoryListing folder="workers/wrangler" />


<br />


<p>
  <strong>maxDepth</strong>
</p>
<DirectoryListing folder="workers/wrangler" maxDepth={2} />


<p>
  <strong>Descriptions</strong>
</p>
<DirectoryListing folder="workers/wrangler" descriptions />

Props

folder

type: string

The folder path to list contents from. If not provided, defaults to the current page's path.

descriptions

type: boolean default: false

When enabled, shows the frontmatter description field for each page in the listing.

maxDepth

type: number default: 1

Controls how many levels of nested pages to display. A value of 1 shows only direct children, while higher values will show deeper nesting levels.

tag

type: string

Optionally, filter the listing to only pages with a specific tag.

Associated content types