diff --git a/reference/components/plugin-api.md b/reference/components/plugin-api.md index 43211396f..3d26a67af 100644 --- a/reference/components/plugin-api.md +++ b/reference/components/plugin-api.md @@ -381,7 +381,7 @@ Function signature for the `'all'` event handler passed to `scope.handleEntry()` ## Example: Static File Server Plugin -A simplified form of the built-in `static` plugin demonstrating key Plugin API patterns: +A simplified form of the built-in `static` plugin demonstrating key Plugin API patterns. For a complete, production example of this API in action, read the plugin's open-source implementation in [`server/static.ts`](https://github.com/HarperFast/harper/blob/main/server/static.ts). ```js export function handleApplication(scope) { diff --git a/reference/static-files/overview.md b/reference/static-files/overview.md index 49a10672b..f2b9355b0 100644 --- a/reference/static-files/overview.md +++ b/reference/static-files/overview.md @@ -19,6 +19,8 @@ The `static` built-in plugin serves static files from your Harper application ov `static` does **not** need to be installed — it is built into Harper and only needs to be declared in your `config.yaml`. +The plugin is open source: its implementation in [`server/static.ts`](https://github.com/HarperFast/harper/blob/main/server/static.ts) is the source of truth for the behavior described on this page. + ## Basic Usage Configure `static` with the `files` option pointing to the files you want to serve: