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

lexicon: make those definitions linkable independent #2

Open
yorkie opened this issue Nov 19, 2019 · 3 comments
Open

lexicon: make those definitions linkable independent #2

yorkie opened this issue Nov 19, 2019 · 3 comments

Comments

@yorkie
Copy link
Contributor

yorkie commented Nov 19, 2019

Hi, we use the plain HTML instead of markdown syntax at lexicon.md, this is not friend to contribution a bit, and the 2nd question is hard to reference a specific definition, which is a very common usage at other glossary tables.

So I'm curious why do we maintain in the HTML way, does a PR to change to markdown headings looks good if I want to contribute to?

@dtex
Copy link
Member

dtex commented Nov 19, 2019

HI @yorkie I used the decription list elements since they are semantically meaningful and define a relationship between the terms and definitions. I wouldn't know how to achieve that using only markdown tags.

@yorkie
Copy link
Contributor Author

yorkie commented Nov 20, 2019

Ok, semantical tag looks strict and meaningful, how about the following changes which does make those linkable in HTML way:

  • embrace the <dt> contents with the tag <h4>, renderer'd add an anchor for that line.
  • use <a href="#some-of-term">...</a>to link them inside the document.

I have created a live edition at https://github.com/yorkie/lexicon/blob/test/src/lexicon.md, I will create a PR if good to you.

@dtex
Copy link
Member

dtex commented Nov 20, 2019

I really like the idea of linkable definitions, but H4's (like dt's) carry semantic meaning. These aren't actually headers so we wouldn't want to imply to search engines or assistive technologies that they are.

One thing I should clarify... The file in src is not meant to be the published document. The HTML file in docs is meant to be viewed at https://ecmatc53.github.io/lexicon. We probably need to elevate that link in the readme so it's the first thing users see.

With that in mind, we could absolutely add this kind of functionality to the published page by modifying the template file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants