search

executablebooks / sphinx-design

A sphinx extension for designing beautiful, screen-size responsive web components.
https://sphinx-design.readthedocs.io/en/furo-theme/
MIT License
193 stars 60 forks source link

👌 Use reference name by default for internal link cards #183

Closed gabalafou closed 4 months ago

gabalafou commented 6 months ago

For cards that link to internal references, we can use the associated name of the reference to supply the link text, so that the link isn't left blank if link-alt is not provided.

welcome[bot] commented 4 months ago

Congrats on your first merged pull request in this project! :tada: congrats
Thank you for contributing, we are very proud of you! :heart:

gabalafou commented 4 months ago

Brilliant!

A few observations, please let me know if you would like me to submit follow-ups for any of them:

  1. The code in the syntax dropdown does not exactly match the two card examples above it. Was that intended? (For comprehension, I find it very helpful when I consult docs if I can easily correlate syntax examples with rendered results, which is harder to do if there are unrendered blocks in the syntax view.)
  2. A distinction that I was trying to make got a bit lost in the docs restructure:
    • External link card? Use link-alt
    • Internal? Do NOT use link-alt
  3. The equivalency paragraphs were a bit hard for me to follow. I think I would find them easier to follow if you add "looks like" in the parentheses: `<https://example.com>` (looks like <https://example.com>)

Thanks!