Night Owl logoNight Owl

An example index

This template is an example of an Index.

The index contains links to all pages in the /docs/ directory. Each page is limited to four items using size, and extra pages have a custom slug.

A dedicated layout handles the meta.index data. Links to all of the items in meta.index.items are added, as well as paginated navigation using meta.index.prev, meta.index.next and meta.index.pages.

{
  "index": {
    "glob": "/docs/**/*",
    "size": 4,
    "slug": "more"
  }
}
meta.index data
{
  "index": {
    "items": [...],
    "page": 2,
    "pages": [...],
    "prev": {
      "src": "src/examples/indexing/index.template.js",
      "dist": "dist/examples/indexing/more/1/index.html",
      "url": "/examples/indexing/more/1"
    },
    "next": {
      "src": "src/examples/indexing/index.template.js",
      "dist": "dist/examples/indexing/more/3/index.html",
      "url": "/examples/indexing/more/3"
    }
  }
}