Overview
Dirwell turns folders into browsable websites. Use live server mode for a local folder or build portable HTML for release downloads, reports and artifacts.
Use the published @dirwell/* packages with Node.js 22.12 or later. The CLI includes Plain: native links and pagination without browser JavaScript. Install Ledger or Crosswave separately for search, sorting and keyboard navigation.
Start with the CLI or compare working examples.
Choose a path
Section titled “Choose a path”| Need | Use |
|---|---|
| Browse changing files | CLI server |
| Publish a folder on a static host | Static build and deployment |
| Configure selection and URLs | Configuration |
| Choose an interface | Themes |
| Add routes to a Node app | SDK server integration |
| Generate alongside an existing build | Build adapters |
| Write a renderer | API reference |
Static output needs no Dirwell server. Live mode reads filesystem data on requests and does not generate an output tree. Optional rich-client updates use SSE; static builds must be rebuilt after source changes.