-
Notifications
You must be signed in to change notification settings - Fork 82
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
Comments
Sorry 回复有点晚。@oldLady344 是个很好的建议!我测试下 readthedocs 主题是否支持显示悬停文字,Thanks! |
我测了下,我用的 readthedocs 主题并不支持显示超链接的悬停文字😩,我得捣鼓一下了。我先去我用的主题 repo 那提了个 issue,可以等一下回复~ |
刚看到的一个关于外部链接 icon 的讨论。可作参考。(不是为了说一定要用或一定不用,就是多个视角) |
赞,我学习下 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
在 source/文档内容元素/链接.md 的"链接至外部站点“的格式:
markdown 编辑外部链接时,建议使用
[link text](URL 'title text')
格式,这里的 title text 写”前往XXX网站"。正常渲染后,将鼠标悬停在超链接上时,屏幕上会显示 title text。例如:Markdown 中文技术文档写作风格指南
渲染后显示如下图所示:
原因:在文档里提供外部链接时,规范作法应该提供一个提示。参考 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)
添加 title 属性原因有三:
The text was updated successfully, but these errors were encountered: