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

Suggestion: Remove a title in the []() syntax in markdown. (h2m converter) #4320

Closed
hochan222 opened this issue Jul 26, 2021 · 2 comments
Closed
Labels
🧑‍🤝‍🧑 community contributions by our wonderful community 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. markdown markdown related issues and pull requests

Comments

@hochan222
Copy link
Member

hochan222 commented Jul 26, 2021

  • Suggestion: Remove a title in the []() syntax in markdown.
    • Final format: [모듈 패턴](http://www.google.com/search?q=javascript+module+pattern)

I had a question while converting html to markdown in that PR.

<a href="http://www.google.com/search?q=javascript+module+pattern" title="http://www.google.com/search?q=javascript+module+pattern">모듈 패턴</a>

I have seen the following code convert as follows.

[모듈 패턴](http://www.google.com/search?q=javascript+module+pattern "http://www.google.com/search?q=javascript+module+pattern")

That grammar was an existing grammar in GFM.

However, I think there is a disadvantage that can be obtained by additionally specifying the title in markdown []().

  • The amount of documents becomes long.
  • Reduces readability.
  • You have to think more about the format by increasing the complexity of the format.
  • In the end, it directly leads to errors in maintenance and can reduce the quality of documents.
  • This is not an attribute that exists in the a tag. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a
    • (But title is an attribute of HTMLElement.)

This is contrary to the reasons for adopting the markdown approach. OWD project: convert MDN content to Markdown

Why do we need a title?

@hochan222 hochan222 changed the title Suggestion: We don't need a title in the []() syntax in markdown. Suggestion: Remove a title in the []() syntax in markdown. Jul 26, 2021
@hochan222 hochan222 changed the title Suggestion: Remove a title in the []() syntax in markdown. Suggestion: Remove a title in the []() syntax in markdown. (h2m converter) Jul 26, 2021
@wbamberg
Copy link
Collaborator

wbamberg commented Jul 26, 2021

Good suggestion, @hochan222 ! I agree that we should remove title attributes from links.

@peterbe
Copy link
Contributor

peterbe commented Jul 26, 2021

If you see

<a href="http://www.google.com/search?q=javascript+module+pattern" title="http://www.google.com/search?q=javascript+module+pattern">모듈 패턴</a>

I think you can safely replace it with

<a href="http://www.google.com/search?q=javascript+module+pattern">모듈 패턴</a>

@github-actions github-actions bot added the 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. label Dec 8, 2021
@schalkneethling schalkneethling added 🧑‍🤝‍🧑 community contributions by our wonderful community markdown markdown related issues and pull requests labels Apr 15, 2022
@caugner caugner closed this as not planned Won't fix, can't repro, duplicate, stale Nov 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍🤝‍🧑 community contributions by our wonderful community 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. markdown markdown related issues and pull requests
Projects
Development

No branches or pull requests

5 participants