hinode/data/structures/live-pages.yml at 5123d1e69a3b23da15c100bd8c56d50d59c84448 · gethinode/hinode · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
comment: >-
  Retrieves a page collection relative to a provided page or optional section.
  Provide tags to ensure the pages have at least one matching tag. You can sort
  the collection by parameter in ascending or descending order.

  As CloudCannon does not support the retrieval of page collection when live
  editing, the partial returns a dummy collection instead.
arguments:
  page:
    type:
      - '*hugolib.pageState'
      - '*hugolib.pageForShortcode'
    optional: true
    comment: Page context, used to retrieve page collections.
    group: partial
  section:
    type: string
    optional: true
    comment: >-
      Name of site section to use for the page collection. When omitted, the
      current page is used as context instead. Use "/" to retrieve the home
      page.
  kind:
    type: select
    optional: true
    default: regular
    comment: >-
      Kind of page collection to use.
    options:
      values:
        - regular
        - related
        - taxonomy
  nested:
    type: bool
    optional: true
    comment: >-
      If set, retrieves all pages below the section or current page recursively.
      By default, only first-order childs are retrieved.
  tags:
    type:
      - string
      - "[]interface {}"
    optional: true
    comment: >-
      Tags to be used as filter. When set, only pages that match at least one of
      the provided tags are retrieved.
  keywords:
    type:
      - string
      - "[]interface {}"
    optional: true
    comment: >-
      Keywords to be used as filter. When set, only pages that match at least
      one of the provided keywords are retrieved.
  categories:
    type:
      - string
      - "[]interface {}"
    optional: true
    comment: >-
      Categories to be used as filter. When set, only pages that belong to at
      least one of the provided categories are retrieved.
  sort:
    type: string
    optional: true
    default: date
    comment: >-
      Page parameter to sort the page collection by. Both default and custom
      parameters can be used.
  reverse:
    type: bool
    optional: true
    default: true
    comment: >-
      If set, returns the page collection in descending order.
  group-by:
    type: select
    optional: true
    comment:
      If set, groups the results by the specified field. Currently only supports
      grouping by section.
    values:
      - section
    release: v2.0.0
  include-list:
    type: bool
    optional: true
    comment:
      If set, includes list pages in the results.
    release: v2.0.0