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

文档站的外部链接支持在后面显示 icon,提示前往外部站点 #6

Closed
oldLady344 opened this issue Sep 30, 2020 · 5 comments · Fixed by #8
Closed

文档站的外部链接支持在后面显示 icon,提示前往外部站点 #6

oldLady344 opened this issue Sep 30, 2020 · 5 comments · Fixed by #8

Comments

@oldLady344
Copy link
Contributor

在 source/文档内容元素/链接.md 的"链接至外部站点“的格式:

markdown 编辑外部链接时,建议使用 [link text](URL 'title text') 格式,这里的 title text 写”前往XXX网站"。正常渲染后,将鼠标悬停在超链接上时,屏幕上会显示 title text。

例如:Markdown 中文技术文档写作风格指南
渲染后显示如下图所示:
image

原因:在文档里提供外部链接时,规范作法应该提供一个提示。参考 Handbook of Technical Writing (Gerald J. Alred, writing for the Web 一节)。一个示例是 google developer documentation style guide 里的描述。(https://developers.google.cn/style/cross-references?hl=zh-cn#out-page)
image

添加 title 属性原因有三:

  • 只是这种外链 icon 效果,不一定所有的 writer 都能找到资源或拥有技术能力来完成。这是一个相对简单的办法。
  • 按 HTML 语法,写超链接时,提供 title 属性信息,是一种良好的习惯,有益于内容的 accessibility。
  • 我的另一个理解:不同网站的使用条款和隐私政策不同,用户使用当前站点,一般默认用户已经接受了当前站点的法律条文。跳出当前站点之前,我们有责任提醒用户当前的链接是去往哪个站点,跳出去之后如果用户发生问题,不是当前站点的责任。
@yikeke
Copy link
Owner

yikeke commented Oct 15, 2020

Sorry 回复有点晚。@oldLady344 是个很好的建议!我测试下 readthedocs 主题是否支持显示悬停文字,Thanks!

@yikeke
Copy link
Owner

yikeke commented Oct 15, 2020

我测了下,我用的 readthedocs 主题并不支持显示超链接的悬停文字😩,我得捣鼓一下了。我先去我用的主题 repo 那提了个 issue,可以等一下回复~

@yikeke
Copy link
Owner

yikeke commented Oct 16, 2020

Hi,我捣鼓了下,坏消息是我用的 readthedocs 主题确实不支持显示 markdown 超链接的悬停文字,这可能跟 sphinx markdown 插件的实现有关。好消息是我配置了下 readthedocs 文档站的 css,目前支持 外链 icon 的效果了:
image

@yikeke yikeke closed this as completed in #8 Oct 16, 2020
@yikeke yikeke changed the title 关于外部链接 文档站的外部链接支持在后面显示 icon,提示前往外部站点 Oct 16, 2020
@oldLady344
Copy link
Contributor Author

Hi,我捣鼓了下,坏消息是我用的 readthedocs 主题确实不支持显示 markdown 超链接的悬停文字,这可能跟 sphinx markdown 插件的实现有关。好消息是我配置了下 readthedocs 文档站的 css,目前支持 外链 icon 的效果了:
image
alphagov/govuk_frontend_toolkit#293

刚看到的一个关于外部链接 icon 的讨论。可作参考。(不是为了说一定要用或一定不用,就是多个视角)

@yikeke
Copy link
Owner

yikeke commented Oct 19, 2020

赞,我学习下

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

Successfully merging a pull request may close this issue.

2 participants