Skip to content

docs: link static plugin implementation as plugin API example #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ethan-Arrowood merged 2 commits into from
Aug 28, 2026
+3 −1
Merged

docs: link static plugin implementation as plugin API example #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e7e1b0
docs: link static plugin implementation as plugin API example
Ethan-Arrowood Aug 27, 2026
e4d100b
docs: hyphenate "open-source" compound modifier
Ethan-Arrowood Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion reference/components/plugin-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
2 changes: 2 additions & 0 deletions reference/static-files/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading