Open neumayr opened 6 years ago
I believe this would be a nice addition, but I'd say this would be better suited via plugin :wink:
I think adding this to core would be a good idea. Then people can migrate from gitbook to vuepress easier if they want.
@neumayr I have recently begun to write a glossarifier. Not particularly for vuepress and I am not planning for it. However it's a tool where you feed markdown in and get markdown out. Thus it is transparent to vuepress and can be integrated as kind of a preprocessing step into a vuepress build pipeline.
If you think glossarify-md is what you are looking for, then you might want to give it a try.
Kudos go to
I am currently working on a Vuepress specific glossary plugin. I will give a link as soon as I get it published.
I have implemented a Glossary plugin for Vuepress. Check it out here: https://www.npmjs.com/package/vuepress-plugin-glossary
All feedback welcome :)
@eeriksp any link to a VP webapp that is using your plugin?
Feature request
This is a feature, originally from
gitbook.io
. I want to bring it up for further discussion. They have a convention for aGLOSSARY.md
file with the following format:📝 https://gitbookio.gitbooks.io/documentation/format/glossary.html
What problem does this feature solve?
Allows you to specify terms and their respective definitions to be displayed in the glossary. Based on those terms, vuepress will automatically build an index and highlight those terms in pages.
What does the proposed API look like?
Scan a pre-defined file (eg.
GLOSSARY.md
) for key/value pairs. Scan the docs copytext where the key matches, add the following markup:<a href="glossary.html#[key]" title="[value]">[key]</a>
How should this be implemented in your opinion?
An example can be found here:
Are you willing to work on this yourself?**
Nope, i would need a lot of help in js context.