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

[Feature Request] Glossary reference #574

Open
neumayr opened this issue Jun 12, 2018 · 6 comments
Open

[Feature Request] Glossary reference #574

neumayr opened this issue Jun 12, 2018 · 6 comments
Labels
type: feature request Request to add a new feature

Comments

@neumayr
Copy link

neumayr commented Jun 12, 2018

Feature request

This is a feature, originally from gitbook.io. I want to bring it up for further discussion.
They have a convention for a GLOSSARY.md file with the following format:

# term
Definition for this term

# Another term
With it's definition, this can contain bold text and all other kinds of inline markup ...

📝 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:

<a href="glossary.html#api" class="glossary-term" title="API is a fun, ambiguous term. It stands for 'Application Programming Interface'. It's a fancy phrase for talking about some agreed-upon way for two programs to talk to each other. It can refer to the specification, as well as the implementation. In recent years, people have often meant 'HTTP API' (or API that uses http as the channel of communication) when talking about APIs. When someone says 'Twitter has an API', they mean Twitter has an HTTP API, which boils down to a special webpage that works as a function. For example, it could be something like twitter.com/api/tweets, which would then respond with a list of all tweets in json format. APIs each have different ways of handling authentication. If you want to see an example of an HTTP api, check out the Co-lab's interactive api documentation page."> API</a>

Are you willing to work on this yourself?**

Nope, i would need a lot of help in js context.

@hmatalonga
Copy link
Contributor

I believe this would be a nice addition, but I'd say this would be better suited via plugin 😉

@ulivz ulivz added the type: feature request Request to add a new feature label Jun 12, 2018
@ycmjason
Copy link
Contributor

I think adding this to core would be a good idea. Then people can migrate from gitbook to vuepress easier if they want.

@about-code
Copy link

about-code commented Aug 31, 2019

@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

@eeriksp
Copy link

eeriksp commented Feb 9, 2020

I am currently working on a Vuepress specific glossary plugin.
I will give a link as soon as I get it published.

@eeriksp
Copy link

eeriksp commented Feb 11, 2020

I have implemented a Glossary plugin for Vuepress. Check it out here: https://www.npmjs.com/package/vuepress-plugin-glossary

All feedback welcome :)

@kefranabg
Copy link
Collaborator

kefranabg commented Feb 12, 2020

@eeriksp any link to a VP webapp that is using your plugin?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request Request to add a new feature
Projects
None yet
Development

No branches or pull requests

7 participants