fix: respect geekdocFileTreeSortBy parameter while creating the toc tree (#771)

This commit is contained in:
Robert Kaussow 2024-01-12 11:56:06 +01:00 committed by GitHub
parent 1d789048f3
commit b750f4ab53
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 50 additions and 4 deletions

View file

@ -8,10 +8,18 @@ The `toc-tree` shortcode will generate a Table of Content from a section file tr
<!-- prettier-ignore-start -->
```tpl
{{</* toc-tree */>}}
{{</* toc-tree [sortBy="title"] */>}}
```
<!-- prettier-ignore-end -->
### Attributes
<!-- prettier-ignore-start -->
<!-- spellchecker-disable -->
{{< propertylist name=shortcode-toc-tree sort=name order=asc >}}
<!-- spellchecker-enable -->
<!-- prettier-ignore-end -->
## Example
As said, the root will be the site on which the shortcode was used, you can see a demo including nesting in the [ToC Tree](/toc-tree/) section.

View file

@ -0,0 +1,8 @@
---
properties:
- name: sortBy
type: string
description: |
Override the default sort parameter set by [`geekdocFileTreeSortBy`](/usage/configuration/#site-configuration).
required: false
defaultValue: .Site.Params.geekdocFileTreeSortBy