fix: add an option to disable new tabs in modern template

dotnet · May 4, 2023 · 8585def · 8585def
1 parent e2c800a
commit 8585def
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/docs/docs/template.md b/docs/docs/template.md
@@ -34,11 +34,11 @@ Name         | Type    | Description
 `_appLogoPath`          | string  | App logo URL path.
 `_appFaviconPath`       | string  | Favicon URL path.
 `_enableSearch`         | bool    | Whether to show the search box.
-`_enableNewTab`         | bool    | Whether to open external links in a new tab.
-`_noindex`              | bool  | Whether to include in search results
+`_noindex`              | bool    | Whether to include in search results
 `_disableContribution`  | bool    | Whether to show the _"Edit this page"_ button.
 `_gitContribute`        | object  | Defines the `repo` and `branch` property of git links.
 `_gitUrlPattern`        | string  | URL pattern of git links.
+`_disableNewTab`        | bool    | Whether to render external link indicator icons and open external links in a new tab.
 `_disableNextArticle`   | bool    | Whether to show the previous and next article link.
 `lang`                 | string | Primary language of the page. If unset, the `<html>` tag will not have `lang` property.
 `layout`                | string  | Determines the layout of the page. Supported values are `landing` and `chromeless`.

diff --git a/samples/seed/index.md b/samples/seed/index.md
@@ -1,6 +1,7 @@
 ---
 layout: landing
 lang: zh-CN
+_disableNewTab: true
 ---
 
 # docfx-seed

diff --git a/templates/modern/layout/_master.tmpl b/templates/modern/layout/_master.tmpl
@@ -22,6 +22,7 @@
       <meta name="docfx:tocrel" content="{{_tocRel}}">
       {{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
       {{#_enableSearch}}<meta name="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
+      {{#_disableNewTab}}<meta name="docfx:disablenewtab" content="true">{{/_disableNewTab}}
       {{#docurl}}<meta name="docfx:docurl" content="{{docurl}}">{{/docurl}}
 
       <script type="module">

diff --git a/templates/modern/src/markdown.ts b/templates/modern/src/markdown.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-import { breakWord } from './helper'
+import { breakWord, meta } from './helper'
 import AnchorJs from 'anchor-js'
 import { html, render } from 'lit-html'
 import mermaid from 'mermaid'
@@ -118,6 +118,10 @@ function renderAlerts() {
  * Open external links to different host in a new window.
  */
 function renderLinks() {
+  if (meta('docfx:disablenewtab') === 'true') {
+    return
+  }
+
   document.querySelectorAll<HTMLAnchorElement>('article a[href]').forEach(a => {
     if (a.hostname !== window.location.hostname && a.innerText.trim() !== '') {
       a.target = '_blank'