Skip to content

docs: document server_middleware filter with example #366

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
stevenjoezhang merged 1 commit into from
Jul 6, 2026
Merged

docs: document server_middleware filter with example #366

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,23 @@ server:
- **header**: Add `X-Powered-By: Hexo` header
- **serveStatic**: Extra options passed to [serve-static](https://github.com/expressjs/serve-static#options)

## Middleware

`hexo-server` runs the `server_middleware` filter before starting the server. Plugins and theme scripts can register [Connect] middleware with it; the filter receives the `app` instance.

For example, to add a custom response header:

``` js
hexo.extend.filter.register("server_middleware", function (app) {
app.use(function (req, res, next) {
res.setHeader("X-Hexo-Middleware", "enabled");
next();
});
});
```

[Connect]: https://github.com/senchalabs/connect

## License

MIT
Expand Down
Loading