2025年如何设置返回目录超链接(怎么设置返回的超链接)

如何设置返回目录超链接(怎么设置返回的超链接)p 本文介绍如何使用 Microsoft Learn 上托管页面的超链接 通过几种不同的约定 便可轻松地将链接添加到 markdown 链接将用户指向相同页面中的内容 其他相邻页面或外部站点和 URL p Microsoft Learn 后端使用开放发布服务 OPS 支持通过 Markdig 分析引擎分析的

大家好,我是讯享网,很高兴认识大家。



 </nav><p>本文介绍如何使用 Microsoft Learn 上托管页面的超链接。 通过几种不同的约定,便可轻松地将链接添加到 markdown。 链接将用户指向相同页面中的内容、其他相邻页面或外部站点和 URL。</p> 

讯享网

Microsoft Learn 后端使用开放发布服务 (OPS),支持通过 Markdig 分析引擎分析的 CommonMark 兼容 Markdown。 Markdown 风格大多与 GitHub Flavored Markdown (GFM) 兼容,因为大多数 docs 存储在 GitHub 中,并可以在 GitHub 中进行编辑。 通过 Markdown 扩展添加一些功能。

链接文本中使用的关键字应反映相关内容。 换言之,它们应为一般中文关键字或所链接到的页面的标题。

更正

错误:

发布系统支持两种类型的超链接:URL文件链接

URL 链接可以是相对于 根的 URL 路径,也可以是包含完整 URL 语法(例如 )的绝对 URL。

  • 链接到当前 docset 之外的内容时,或在 docset 中的自动生成的参考和概念文章之间链接时,请使用 URL 链接
  • 创建相对链接的最简单方法是从浏览器复制 URL,然后从粘贴到 Markdown 中的值中删除 。
  • 请勿在 Microsoft 属性的 URL 中包括区域设置(例如,从 URL 中删除 )。

文件链接用于在 docset 中从一篇文章链接到另一篇文章。

  • 所有文件路径都使用正斜杠 () 字符,而不是反斜杠字符。
  • 一篇文章链接到同一目录中的另一篇文章:

  • 一篇文章链接到当前目录的父目录中的一篇文章:

  • 一篇文章链接到当前目录的子目录中的一篇文章:

  • 一篇文章链接到当前目录的父目录的子目录中的一篇文章:

  • 有些文章由 和 文件组成,其中 文件包含元数据, 包含内容。 在这种情况下,请链接到 文件:


    讯享网

    不是

Microsoft Learn 上发布的内容具有以下 URL 结构:

示例:

讯享网
  • - 标识文章的语言(例如 en-us 或 de-de)
  • - 产品或服务的名称(例如 powershell、dotnet 或 azure)
  • -(可选)产品功能或子服务的名称(例如 csharp 或 load-balancer)
  • -(可选)功能中子文件夹的名称
  • - 主题的文章文件的名称(例如 load-balancer-overview 或 overview)
  • -(可选)具有多个可用版本的内容的版本选择器使用的视图名称(例如 azps-3.5.0)

对于当前文件中标题的书签链接,请使用哈希符号,后跟标题的小写字词。 删除标题中的标点符号并将空格替换为短划线:

 

若要链接到另一篇文章中的某个书签标题,请使用文件相对或站点相对链接以及井号,后跟标题内容。 删除标题中的标点符号并将空格替换为短划线:

讯享网

还可以从 URL 复制书签链接。 若要查找 URL,请将鼠标悬停在 Microsoft Learn 上的标题行上。 应该会看到一个链接图标出现:

文章标题中的链接图标

单击链接图标,然后从 URL 复制书签定位文本(即哈希后的部分)。

使用 HTML 标记添加显式定位标记链接并非必需,也不推荐使用,但在中心和登录页面中除外。 请改为使用自动生成的书签,如书签链接中所述。 对于中心和登录页面,声明如下所示的定位标记:

 

讯享网

以下链接到定位标记:

 

XRef 链接是链接到 API 的推荐方式,因为它们使自定义链接文本变得容易。 此外,它们在生成时进行验证,如果 API 引用的 URL 发生更改,则链接仍然有效。 若要链接到当前文档集或其他文档集中自动生成的 API 参考页,请使用具有类型或成员的唯一 ID (UID) 的 XRef 链接。

通过在 .NET API 浏览器或 Windows UWP 搜索框中键入其所有或部分全名,检查要链接到的 API 是否在 Microsoft Learn 上发布。 如果未显示任何结果,则该类型尚不在 Microsoft Learn 上。

可使用下列某一语法:

  • 自动链接:
    讯享网

    默认情况下,链接文本仅显示成员或类型名称。 可选 查询参数生成完全限定的链接文本,即类型 namespace.type,以及类型成员(包括枚举类型成员)type.member

  • Markdown 样式链接:
     

    如果要自定义显示的链接文本,请使用适用于 XRef 的 Markdown 样式链接。

示例:

  • <xref:System.String> 显示为

  • <xref:System.String?displayProperty=nameWithType> 显示为
  • [String class](xref:System.String) 显示为字符串类。

查询参数的工作方式与类的 相同。 也就是说,链接文本将成为 namespace.classname。 但是,对于成员,链接文本显示为 namespace.classname.membername,这可能不可取。

UID 通常是完全限定的类或成员名称。 若要确定 UID,请右键单击某一类型或成员的 Microsoft Learn 页,选择查看源,然后复制 ms.assetid内容值。

网页源中的 ms.assetid

UID 中的特殊字符需要进行百分比编码,如下所示:

字符 HTML 编码 *

编码示例:

  • 编码为

泛型类型是诸如 这样的类型。 如果在 .NET API 浏览器中浏览到此类型并查看其 URL,你会看到 在 URL 中编写为 ,这实际上表示 `1

若要链接到方法,可以通过在方法名称后添加星号 () 链接到常规方法页面,或链接到特定重载。 例如,如果要链接到没有特定参数类型的 方法,请使用“常规”页面。 例如:

链接到

要链接到特定重载,请在方法名称后添加括号,并包含每个参数的完整类型名称。 请勿在类型名称之间放置空格字符,否则链接将无法正常工作。 例如:

链接到

包含文件位于另一个目录中,因此,必须使用较长的相对路径。 若要从包含文件链接到某一篇文章,请使用以下格式:

讯享网

选择器是导航组件,以下拉列表的形式在文档文章中显示。 当读者选择下拉列表中的值时,浏览器将打开所选文章。 通常情况下,选择器列表包含密切相关文章的链接,例如,多种编程语言中的相同主题,或密切相关的文章系列。

如果你的选择器嵌入在包含文件中,则使用以下链接结构:

 

可以使用引用样式链接使源内容更易于读取。 引用样式链接使用简化的语法替代内联链接语法,以便将长 URL 移动到文章末尾。 下面是 Daring Fireball 的示例:

内联文本:

讯享网

文章末尾部分的链接引用:

 

请务必在链接前的冒号后加入空格。 链接到其他技术文章时,如果忘记加入空格,链接会在发布文章中被破坏。

若要链接到另一个 Microsoft 属性(例如定价页、SLA 页或其他非文档文章的页面),请使用绝对 URL,但要忽略区域设置。 这样做是为了使链接在 GitHub 和显示链接的网站上正常工作:

讯享网

为了实现**用户体验,最好尽量减少将用户定向到另一个网站的次数。 因此,有关任何第三方网站链接(有时确实需要)的**做法如下:

  • 责任性:当要共享的信息是第三方信息时,链接到第三方内容。 例如,告知用户如何使用 Android 开发人员工具并不是 Microsoft 的职责,此类信息可以通过 Google 获取。 如有需要,我们可以介绍如何将 Android 开发人员工具与 Azure 结合使用,但对于如何使用该工具,应向 Google 寻求帮助。
  • PM 签名:请求 Microsoft 在第三方内容上签名。 链接到此内容即表明我们信任此内容,并且有责任和义务让用户按说明操作。
  • 适时检查更新:确保第三方信息保持持续适用性、正确性和相关性,并确保链接未经任何更改。
  • 跳转提醒:确保用户知道他们即将转到另一个网站。 如果上下文未明确指出这一点,请添加一个限定性句子。 例如:“先决条件包括 Android 开发人员工具,你可以在 Android Studio 网站上进行下载”。
  • 后续步骤:在“后续步骤”部分,最好添加一个指向类似于 MVP 博客等内容的链接。 再次提醒,请务必使用户了解他们会离开当前网站。
  • 合法性:合法遵守每个 microsoft.com 页面使用条款页脚中的链接到第三方网站规定。


小讯
上一篇 2025-06-12 13:35
下一篇 2025-04-15 09:28

相关推荐

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/179770.html