docs(filter): point server_middleware to hexo-server README#2563
docs(filter): point server_middleware to hexo-server README#2563VibhorGautam wants to merge 1 commit into
Conversation
|
✅ Theme thumbnails validation completed. |
There was a problem hiding this comment.
💡 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".
|
|
||
| [Connect]: https://github.com/senchalabs/connect | ||
| [hexo-server]: https://github.com/hexojs/hexo-server | ||
| [hexo-server README]: https://github.com/hexojs/hexo-server#middleware |
There was a problem hiding this comment.
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 👍 / 👎.
88e31e9 to
f7970b2
Compare
Closes #2325.
As noted in #2325,
server_middlewareis provided by hexo-server, not Hexo core, so the example on theapi/filterpage 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.