Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shu307 committed Nov 17, 2023
1 parent fed18b9 commit 3fd22a5
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Four additional keys can be configured in Markdown Metadata ( also known as "fro
- **Value: number, eg: `-1`, `2.3` ..., if unset, it goes `0`**.
- like weight in Hugo but has some differences, used for ordering your sections/pages. Lower weight gets higher precedence. So content with lower weight will come first.
- **`weight` in an `index` will be offered to its parent `section`**, there is a fixed value for itself, and the value is configurable, see: [`index_weight`](#index_weight).
- **For those who are confused, only weights of the items in same folder will be compared**

- `headless: bool`
- **Value: bool, `true` or `false`, if unset, it goes `false`**.
Expand Down
1 change: 1 addition & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- **值: number, 如 `-1`, `2.3` ..., 未设置,则为 `0`**.
- 类似于 Hugo 中的 weight ,但有一些差异,用于对 section 和 page 排序。 weight 越低,顺序越靠前。
- **`index` 中的 `weight` 会被提供给其父 `section`**, 其本身有一个可配置的固定值,见: [`index_weight`](#index_weight).
- **weight 的作用域只在同文件夹**

- `headless: bool`
- **值: bool, `true` or `false`, 未设置,则为 `false`**.
Expand Down

0 comments on commit 3fd22a5

Please sign in to comment.