Skip to content
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

Jump to bottom

docs(variables): fix returned type #1568

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(variables): fix returned type #1568

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
6 changes: 4 additions & 2 deletions source/docs/variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@ Lodash has been removed from global variables since Hexo 5.0.0. [You-Dont-Need-L

Variable | Description | Type
--- | --- | ---
`site.posts` | All posts | `array` of `post` objects
`site.pages` | All pages | `array` of `page` objects
`site.posts` | All posts | [Query][queryo] object
`site.pages` | All pages | [Query][queryo] object
`site.categories` | All categories | `array` of ???
Copy link
Member

Choose a reason for hiding this comment

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

site.categories and site.tags are also Query object. Documentation for other languages can also be updated

Copy link
Member

Choose a reason for hiding this comment

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

See also https://github.com/hexojs/hexo/blob/740a0d6a94a8f3a096a5315ec3e8c45328994e93/lib/hexo/index.js#L193-L221

`site.tags` | All tags | `array` of ???

[queryo]:http://hexojs.github.io/warehouse/Query.html
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[queryo]:http://hexojs.github.io/warehouse/Query.html
[queryo]: https://hexojs.github.io/warehouse/classes/query.Query.html


### Page Variables

**Article (`page`)**
Expand Down