{"id":29374620,"url":"https://github.com/hexojs/hexo-generator-index","last_synced_at":"2025-07-09T20:09:57.948Z","repository":{"id":25166038,"uuid":"28589020","full_name":"hexojs/hexo-generator-index","owner":"hexojs","description":"Index generator plugin for Hexo.","archived":false,"fork":false,"pushed_at":"2025-05-05T20:30:25.000Z","size":81,"stargazers_count":53,"open_issues_count":3,"forks_count":44,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-06-08T22:09:10.889Z","etag":null,"topics":["hexo","hexo-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hexojs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-12-29T10:44:32.000Z","updated_at":"2025-02-06T13:13:22.000Z","dependencies_parsed_at":"2023-01-14T02:14:51.288Z","dependency_job_id":"917f6d41-08de-4bb9-b672-93a8451d7bd7","html_url":"https://github.com/hexojs/hexo-generator-index","commit_stats":{"total_commits":72,"total_committers":17,"mean_commits":4.235294117647059,"dds":0.8194444444444444,"last_synced_commit":"f8ef61c1c8d2006d132d536657f0dee1b38d632a"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/hexojs/hexo-generator-index","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexojs%2Fhexo-generator-index","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexojs%2Fhexo-generator-index/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexojs%2Fhexo-generator-index/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexojs%2Fhexo-generator-index/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hexojs","download_url":"https://codeload.github.com/hexojs/hexo-generator-index/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexojs%2Fhexo-generator-index/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264268006,"owners_count":23582044,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hexo","hexo-plugin"],"created_at":"2025-07-09T20:09:54.818Z","updated_at":"2025-07-09T20:09:57.940Z","avatar_url":"https://github.com/hexojs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hexo-generator-index\n\n[![Build Status](https://github.com/hexojs/hexo-generator-index/workflows/Tester/badge.svg?branch=master)](https://github.com/hexojs/hexo-generator-index/actions?query=workflow%3ATester)\n[![NPM version](https://badge.fury.io/js/hexo-generator-index.svg)](https://www.npmjs.com/package/hexo-generator-index)\n[![Coverage Status](https://img.shields.io/coveralls/hexojs/hexo-generator-index.svg)](https://coveralls.io/r/hexojs/hexo-generator-index?branch=master)\n\nIndex generator for [Hexo].\n\nIt generates an archive of posts on your homepage, according to the `index` or `archive` layout of your theme.\n\n## Installation\n\n```bash\nnpm install hexo-generator-index --save\n```\n\n## Options\n\nAdd or modify the following section to your root `_config.yml` file.\n\n```yaml\nindex_generator:\n  path: \"\"\n  per_page: 10\n  order_by: -date\n  pagination_dir: page\n  layout: [\"index\", \"archive\"]\n```\n\n- **path**: Root path for your blog's index page.\n  - default: `\"\"`\n- **per_page**: Posts displayed per page.\n  - default: [`config.per_page`](https://hexo.io/docs/configuration.html#Pagination) as specified in the official Hexo docs (if present), otherwise `10`\n  - `0` disables pagination.\n- **order_by**: Posts order.\n  - default: `-date` (date descending)\n- **pagination_dir**: URL format.\n  - default: `page`\n  - e.g. set `awesome-page` makes the URL ends with `awesome-page/\u003cpage number\u003e` for second page and beyond.\n- **layout**: custom layout.\n  - defalut: `[\"index\", \"archive\"]`\n\n## Usage\n\nThe `sticky` parameter in the post [Front-matter](https://hexo.io/docs/front-matter) will be used to pin the post to the top of the index page. Higher `sticky` means that it will be ranked first.\n\n```yml\n---\ntitle: Hello World\ndate: 2013/7/13 20:46:25\nsticky: 100\n---\n```\n\nThe `hidden` parameter can be used to hide a post from the index page. When `hidden: true` is set, the post will not appear in the index but will still be accessible in other ways (e.g., the archive page or via a direct link).\n\n```yml\n---  \ntitle: Secret Post  \ndate: 2024/11/11 11:11:11  \nhidden: true  \n---  \n```\n\n## Note\n\nIf your theme define a non-archive `index` layout (e.g. About Me page), this plugin would follow that layout instead and not generate an archive. In that case, use [hexo-generator-archive](https://github.com/hexojs/hexo-generator-archive) to generate an archive according to the `archive` layout.\n\n## License\n\nMIT\n\n[Hexo]: https://hexo.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhexojs%2Fhexo-generator-index","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhexojs%2Fhexo-generator-index","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhexojs%2Fhexo-generator-index/lists"}