Examples

Choose an interface, customize an explorer, or connect Dirwell to a Node application. Browser demos open the generated explorer. Server integrations link to a local run guide and source code.

Official themes

Plain comes with the CLI. Install Ledger or Crosswave for search, sorting and keyboard navigation.

• Ledger: Search, sort, and browse a folder with bundled file icons. Open demo · Source and instructions
• Plain: Minimal directory HTML with native links, system fonts, and no generated assets. Open demo · Source and instructions
• Crosswave: A PSP-inspired crossbar with flowing light and keyboard or controller navigation. Open demo · Source and instructions

Customization and deployment

Change colors, languages, file categories, share images or deployment URLs.

• Choose directory URLs: Compare explicit filenames, directory indexes and extensionless routing. Run locally · Source and instructions
• Deploy under a URL prefix: Share assets across pages and mount the explorer under a known URL prefix. Open demo · Source and instructions
• Customize Ledger source: Keep the explorer behavior while changing colors, icons, and its header. Open demo · Source and instructions
• Build an independent theme: Replace the full document with your own HTML and CSS. Open demo · Source and instructions
• Add theme-owned languages: Switch English, Traditional Chinese, and Japanese in an independent theme. Open demo · Source and instructions
• Customize Crosswave categories: Rename and reorder categories, choose icons, and define file-type filters. Open demo · Source and instructions
• Generate per-folder share images: Generate an image for each folder in a small Design kit. Open demo · Source and instructions

Server integrations

Run Dirwell inside a Node application and connect it to your services.

• Cache a public listing: Run two Hono servers that share listing data through Redis. Run locally · Source and instructions

Build a static example

Each source directory includes a README and a TypeScript config.ts that selects its theme, input folder and output. These configs use the Dirwell API; they are not CLI configuration files.

From an installed repository checkout:

node scripts/build-example.ts file-icons ./generated-example

Serve the complete generated-example directory over HTTP. For the URL-prefix example, use the /examples/base/ path described in its README so its links resolve correctly.

To build your own folder without a repository checkout, follow Getting started. To work on the Dirwell documentation website, see Contributing.