Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add 'shortTitle' as a top matter option to enable shorter links in the sidebar for long titles #21

Open
smagdali opened this issue Jan 26, 2023 · 0 comments
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

Comments

@smagdali
Copy link

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

@github-project-automation github-project-automation bot moved this to 👣 Needs triage in Protocol Docs Apr 4, 2023
@johnnymatthews johnnymatthews added 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 labels Apr 4, 2023
@johnnymatthews johnnymatthews moved this from 👣 Needs triage to 📋 Backlog in Protocol Docs Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants