Browse Source

Mention sorting in readme

index-subcmd
Vincent Prouillet 7 years ago
parent
commit
177826a110
1 changed files with 4 additions and 0 deletions
  1. +4
    -0
      README.md

+ 4
- 0
README.md View File

@@ -124,6 +124,10 @@ You can also set the `template` variable to change which template will be used t
Sections will also automatically pick up their subsections, allowing you to make some complex pages layout and Sections will also automatically pick up their subsections, allowing you to make some complex pages layout and
table of contents. table of contents.


You can define how a section pages are sorted using the `sort_by` key in the front-matter. The choices are `date` (default), `order`
and `none`. Pages that can be sorted will currently be silently dropped: the final page will be rendered but it will not appear in
the `pages` variable in the section template.

A special case is the `_index.md` at the root of the `content` directory which represents the homepage. It is only there A special case is the `_index.md` at the root of the `content` directory which represents the homepage. It is only there
to control pagination and sorting of the homepage. to control pagination and sorting of the homepage.




Loading…
Cancel
Save