add 'shortTitle' as a top matter option to enable shorter links in the sidebar for long titles #21
Labels
dif/medium
Prior experience is likely helpful
effort/hours
Estimated to take one or several hours
P2
Medium: Good to have, but can wait until someone steps up
It would be good to be able to sometimes use a shorter text in the sidebar title from the main title - especially as the title: becomes the H1
As an example, imagine the following in your top matter:
title: "Frequently Asked Questions about the Filecoin Virtual Machine"
shortTitle: "FAQs"
should give you a nice long title and H1 for the page, but a sidebar link that's completely clear from the context but much more manageable. Helps readability and discoverability.
We do this by (copy/paste from discussion with @johnnymatthews ):
Add conditionals to the following to enable a different sidebar menu linktext, from the main title:
https://github.com/filecoin-project/filecoin-docs/blob/main/layouts/_default/list.html
https://github.com/filecoin-project/filecoin-docs/blob/main/layouts/partials/sidebar/auto-default-menu.html
The text was updated successfully, but these errors were encountered: