Skip to content

Commit c6a1c8b

Browse files
committed
Clearer page sorting comment
1 parent 7cea0bb commit c6a1c8b

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/content/documentation/content/section.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ to newest (at the bottom).
159159
`reverse` has no effect on `page.later`/`page.earlier` or `page.heavier`/`page.lighter`.
160160

161161
## Sorting subsections
162-
Sorting sections is a bit less flexible: sections are always sorted by `weight`,
162+
Sorting sections is a bit less flexible: sections can only be sorted by `weight`,
163163
and do not have variables that point to the heavier/lighter sections.
164164

165165
By default, the lightest (lowest `weight`) subsections will be at

docs/content/documentation/templates/pages-sections.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ path: String;
8080
components: Array<String>;
8181
permalink: String;
8282
extra: HashMap<String, Any>;
83-
// Pages directly in this section, sorted if asked
83+
// Pages directly in this section. By default, the pages are not sorted. Please set the "sorted_by"
84+
// variable in the _index.md file of the corresponding section to "date" or "weight" for sorting by
85+
// date and weight, respectively.
8486
pages: Array<Page>;
8587
// Direct subsections to this section, sorted by subsections weight
8688
// This only contains the path to use in the `get_section` Tera function to get

0 commit comments

Comments
 (0)