Documentation improvement - show fn syntax at top of the page

[AndreiIgna]

I use date-fns in many projects, and sometimes I need to check the documentation to see a function's syntax.

Every time I open a docs page (ex: https://date-fns.org/v2.16.1/docs/format) I was expecting to see the usage, arguments, etc at the top. But I see the descriptions are at the top, and need to scroll a long way to find this:

For this specific page, an important piece of information is almost at the end 😕

Other projects show usage or function name with accepted arguments at the top:

and I think showing function syntax at the top will be an improvment for date-fns. Ex:

Just wanna start a discussion to see if others noticed this and suggest an option. Sometimes the code editor with autocomplete is enough, but there are moments when we check the docs site too.

[tan75]

Hi @AndreiIgna

Thank you for the idea - this is a great suggestion and a PR is welcome! The only thing I would suggest is to make the syntax look as follows:

Could you please submit a PR if you wish to continue?