gohugoio / hugoDocs

The source for https://gohugo.io/
Apache License 2.0
1.05k stars 1.48k forks source link

Docs are missing documentation for configuration setting _paginate = NN_ #2652

Closed irkode closed 1 month ago

irkode commented 1 month ago

There are some references that there's something configured in the configuration file. But without any details and the effect.

seems setting paginate = NN affects both .Paginate and .Paginator.

https://gohugo.io/methods/page/paginate/

By default, the number of elements on each pager is determined by your site configuration. The default is 10.

https://gohugo.io/methods/page/paginator/

The number of elements on each pager is determined by your site configuration. The default is 10.

Both then link to the pagination configuration which only lists PagerSize I would have expected to have that in "All Configuration Settings"

Its defined in the docs repo at

bep commented 1 month ago
paginate: 0
paginatePath: ""

The two above was replaced by a pagination struct a while ago so they're deprecated and undocumented.

See https://gohugo.io/getting-started/configuration/#pagination

irkode commented 1 month ago

thought like so ;-)

please keep in mind that there are a lot of old sites out there and the number grows. and it's hard to find "vanished" stuff. In some cases things are removed, others not, no deprecation warning when building -

for paginate it just works like a charm.

I found no (easy) way to find out deprecated/removed methods and matching version.

Did I oversee some docs / notes - is there an option.

If not we could consider to build a list listing deprecated remoed stuff per version.

On the long run people will ignore such message if everything works - and I would consider the contained code "technical dept"