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

Link preview text #137

Closed
MaxHillebrand opened this issue Aug 10, 2019 · 3 comments · Fixed by #139
Closed

Link preview text #137

MaxHillebrand opened this issue Aug 10, 2019 · 3 comments · Fixed by #139
Labels
help wanted Extra attention is needed structure Regarding the structure of VuePress and GitHub visual Regarding the UI of the documentation

Comments

@MaxHillebrand
Copy link
Collaborator

Problem

Right now the link preview text shows always the same, regardless what link is used. This is unspecific and does not give an accurate preview of what the linked content actually is.

screenshot_20190810_113125

Solution

Is it possible to give a more precise preview, either for the specific markdown file [in this case a summary of the BIP.md file] or even better, for the specific header within the markdown file [in this case a summary of BIP158].

@MaxHillebrand MaxHillebrand added help wanted Extra attention is needed visual Regarding the UI of the documentation structure Regarding the structure of VuePress and GitHub labels Aug 10, 2019
@dennisreimann
Copy link
Contributor

Special preview text for single headers aren‘t possible, as the information is provided on a per page basis.
The preview text is adjustable via the description meta information, which can be added to the page frontmatter.

@MaxHillebrand
Copy link
Collaborator Author

MaxHillebrand commented Aug 11, 2019

Thanks Dennis!

Just to clarify, at the top of each markdown file we can put this?

---
description: "foo bar foo."
---

and this overwrites the default here?

https://github.com/zkSNACKs/WasabiDoc/blob/4f6c3ed5611b40e3b2350f9456010e341eaaeb76/docs/.vuepress/config.js#L7

@dennisreimann
Copy link
Contributor

Yes, for details see the frontmatter reference of VuePress. Providing this information will also help with #40 😀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed structure Regarding the structure of VuePress and GitHub visual Regarding the UI of the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants