Skip to content

docs(filter): point server_middleware to hexo-server README#2563

Open
VibhorGautam wants to merge 1 commit into
hexojs:masterfrom
VibhorGautam:docs/filter-server-middleware-link
Open

docs(filter): point server_middleware to hexo-server README#2563
VibhorGautam wants to merge 1 commit into
hexojs:masterfrom
VibhorGautam:docs/filter-server-middleware-link

Conversation

@VibhorGautam

@VibhorGautam VibhorGautam commented Jun 6, 2026

Copy link
Copy Markdown

Closes #2325.

As noted in #2325, server_middleware is provided by hexo-server, not Hexo core, so the example on the api/filter page is misleading: it does not run unless hexo-server is installed.

Following the suggestion in the issue, this trims the section to a short note that the filter comes from hexo-server and links to its README for the implementation example. The example itself is added in hexojs/hexo-server#366, so that PR should land first (the README anchor depends on it).

Scope: English page only. The translated pages (ja, ru, zh-cn, zh-tw, pt-br, ko, es, th) still carry the old inline example and can be synced separately.

@github-actions github-actions Bot added en lang: en API labels Jun 6, 2026
@github-actions

github-actions Bot commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

✅ Theme thumbnails validation completed.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 88e31e9c1d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread source/api/filter.md

[Connect]: https://github.com/senchalabs/connect
[hexo-server]: https://github.com/hexojs/hexo-server
[hexo-server README]: https://github.com/hexojs/hexo-server#middleware

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Point the README link at an existing example

The new note sends readers to https://github.com/hexojs/hexo-server#middleware, but I checked the linked hexo-server README on master and it only has Installation, Usage, Options, and License headings, so the #middleware anchor does not exist and there is no implementation example there. When users follow this documentation they land on the top of the README without the promised server_middleware guidance; this should either keep the example here or link to a committed page/PR once that Middleware section exists.

Useful? React with 👍 / 👎.

@VibhorGautam VibhorGautam force-pushed the docs/filter-server-middleware-link branch from 88e31e9 to f7970b2 Compare June 6, 2026 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API en lang: en

Projects

None yet

Development

Successfully merging this pull request may close these issues.

remove "server_middleware" from "api/filter"

1 participant