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

Provide text entry for VPDocFooter #758

Closed
4 tasks done
userquin opened this issue Jun 8, 2022 · 3 comments · Fixed by #897
Closed
4 tasks done

Provide text entry for VPDocFooter #758

userquin opened this issue Jun 8, 2022 · 3 comments · Fixed by #897
Labels
enhancement New feature or request theme Related to the theme

Comments

@userquin
Copy link
Member

userquin commented Jun 8, 2022

Is your feature request related to a problem? Please describe.

When the text on the link is contextual there is no way to include an alternative text to be shown on next/prev footer.

Describe the solution you'd like

Add an optional text entry on SidebarItem and use it on VPDocFooter if configured.

Describe alternatives you've considered

No response

Additional context

We have a Getting Started on each group:

imagen


Here you can check the text is not in context (the next entry should be Getting Started | Frameworks):

imagen

Validations

@userquin userquin changed the title provide text entry for VPDocFooter [next]: provide text entry for VPDocFooter Jun 8, 2022
@userquin userquin changed the title [next]: provide text entry for VPDocFooter [next] provide text entry for VPDocFooter Jun 8, 2022
kecrily added a commit to kecrily/vitepress that referenced this issue Jun 9, 2022
@kiaking kiaking changed the title [next] provide text entry for VPDocFooter Provide text entry for VPDocFooter Jun 14, 2022
@kiaking kiaking added enhancement New feature or request theme Related to the theme labels Jun 14, 2022
@kiaking
Copy link
Member

kiaking commented Jun 14, 2022

I like the idea. For design, I think we can learn from this 👀
https://docs.gitbook.com/spaces/what-is-a-space

@kecrily
Copy link
Contributor

kecrily commented Jun 16, 2022

A late rendering. I think this is a bit more visible than the gitbook one

image

@userquin
Copy link
Member Author

userquin commented Jun 18, 2022

@kiaking @kecrily I configure the title this way Title | Section on frontmatter section (like on the last screenshot), maybe you can access to it and use it on the next/prev links, if possible: just add also a hint on the docs.

This way you only need to change how to get the title from fontmatter, the layout will be the same.

Just check this https://github.com/antfu/vite-plugin-pwa/blob/main/docs/guide/index.md (any other page is configured this way on pwa repo)

EDIT: the logic should apply when the context changes, if applied always maybe there is no space to add the title.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request theme Related to the theme
Projects
None yet
3 participants