Add a new guideline about adding external link hint #8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
请简要描述你改动的内容(有的话也请提供参考的 issue 或其他链接)
To close #6
以下建议来自 oldLady344 ,Thanks a lot!
在 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 属性原因有三: