feat(v2): Add themeConfig.noIndex optionthrough ssrTemplate

facebook · Oct 12, 2020 · a4a5503 · a4a5503
1 parent cb6fe8b
commit a4a5503
Show file tree

Hide file tree

Showing 12 changed files with 15 additions and 17 deletions.
diff --git a/packages/docusaurus-theme-bootstrap/src/theme/DebugLayout/index.tsx b/packages/docusaurus-theme-bootstrap/src/theme/DebugLayout/index.tsx
@@ -24,7 +24,6 @@ function Layout(props: Props): JSX.Element {
     themeConfig: {image: defaultImage, metadatas},
     url: siteUrl,
     titleDelimiter,
-    noIndex,
   } = siteConfig;
   const {
     children,
@@ -67,7 +66,6 @@ function Layout(props: Props): JSX.Element {
           <meta name="twitter:image:alt" content={`Image for ${metaTitle}`} />
         )}
         {permalink && <meta property="og:url" content={siteUrl + permalink} />}
-        {noIndex && <meta name="robots" content="noindex" />}
         <meta name="twitter:card" content="summary_large_image" />
       </Head>
       <Head

diff --git a/packages/docusaurus-theme-bootstrap/src/theme/DocItem/index.tsx b/packages/docusaurus-theme-bootstrap/src/theme/DocItem/index.tsx
@@ -15,12 +15,7 @@ import {Props} from '@theme/DocItem';
 
 function DocItem(props: Props): JSX.Element {
   const {siteConfig = {}} = useDocusaurusContext();
-  const {
-    url: siteUrl,
-    title: siteTitle,
-    titleDelimiter = ' | ',
-    noIndex,
-  } = siteConfig;
+  const {url: siteUrl, title: siteTitle, titleDelimiter = ' | '} = siteConfig;
   const {content: DocContent} = props;
   const {metadata} = DocContent;
   const {description, title, permalink} = metadata;
@@ -54,7 +49,6 @@ function DocItem(props: Props): JSX.Element {
           <meta name="twitter:image:alt" content={`Image for ${title}`} />
         )}
         {permalink && <meta property="og:url" content={siteUrl + permalink} />}
-        {noIndex && <meta name="robots" content="noindex" />}
       </Head>
       <main className="col col-md-8 p-0">
         <DocContent />

diff --git a/packages/docusaurus-theme-classic/src/theme/DocItem/index.tsx b/packages/docusaurus-theme-classic/src/theme/DocItem/index.tsx
@@ -25,7 +25,7 @@ import {
 
 function DocItem(props: Props): JSX.Element {
   const {siteConfig} = useDocusaurusContext();
-  const {url: siteUrl, title: siteTitle, titleDelimiter, noIndex} = siteConfig;
+  const {url: siteUrl, title: siteTitle, titleDelimiter} = siteConfig;
   const {content: DocContent} = props;
   const {metadata} = DocContent;
   const {
@@ -77,7 +77,6 @@ function DocItem(props: Props): JSX.Element {
         )}
         {permalink && <meta property="og:url" content={siteUrl + permalink} />}
         {permalink && <link rel="canonical" href={siteUrl + permalink} />}
-        {noIndex && <meta name="robots" content="noindex" />}
       </Head>
       <div
         className={clsx('container padding-vert--lg', styles.docItemWrapper)}>

diff --git a/packages/docusaurus-theme-classic/src/theme/Layout/index.tsx b/packages/docusaurus-theme-classic/src/theme/Layout/index.tsx
@@ -36,7 +36,6 @@ function Layout(props: Props): JSX.Element {
     themeConfig: {image: defaultImage, metadatas},
     url: siteUrl,
     titleDelimiter,
-    noIndex,
   } = siteConfig;
   const {
     children,
@@ -76,7 +75,6 @@ function Layout(props: Props): JSX.Element {
         )}
         {permalink && <meta property="og:url" content={siteUrl + permalink} />}
         {permalink && <link rel="canonical" href={siteUrl + permalink} />}
-        {noIndex && <meta name="robots" content="noindex" />}
         <meta name="twitter:card" content="summary_large_image" />
       </Head>
 

diff --git a/packages/docusaurus-types/src/index.d.ts b/packages/docusaurus-types/src/index.d.ts
@@ -22,6 +22,7 @@ export interface DocusaurusConfig {
   url: string;
   onBrokenLinks: ReportingSeverity;
   onDuplicateRoutes: ReportingSeverity;
+  noIndex: boolean;
   organizationName?: string;
   projectName?: string;
   githubHost?: string;
@@ -51,7 +52,6 @@ export interface DocusaurusConfig {
       }
   )[];
   titleDelimiter?: string;
-  noIndex?: boolean;
 }
 
 /**
@@ -123,7 +123,6 @@ export interface LoadContext {
   outDir: string;
   baseUrl: string;
   ssrTemplate?: string;
-  noIndex?: boolean;
 }
 
 export interface InjectedHtmlTags {

diff --git a/packages/docusaurus/src/client/serverEntry.js b/packages/docusaurus/src/client/serverEntry.js
@@ -51,6 +51,7 @@ export default async function render(locals) {
     onLinksCollected,
     baseUrl,
     ssrTemplate,
+    noIndex,
   } = locals;
   const location = routesLocation[locals.path];
   await preload(routes, location);
@@ -101,6 +102,7 @@ export default async function render(locals) {
     metaAttributes,
     scripts,
     stylesheets,
+    noIndex,
     version: packageJson.version,
   });
 

diff --git a/packages/docusaurus/src/client/templates/index.html.template.ejs b/packages/docusaurus/src/client/templates/index.html.template.ejs
@@ -5,6 +5,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="Docusaurus">
     <title><%= htmlWebpackPlugin.options.title %></title>
+    <%if (htmlWebpackPlugin.options.noIndex) { %>
+      <meta name="robots" content="noindex" />
+    <% } %>
     <%= htmlWebpackPlugin.options.headTags %>
     <%= htmlWebpackPlugin.tags.headTags %>
   </head>

diff --git a/packages/docusaurus/src/client/templates/ssr.html.template.js b/packages/docusaurus/src/client/templates/ssr.html.template.js
@@ -12,6 +12,9 @@ module.exports = `
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="Docusaurus v<%= it.version %>">
+    <%if (it.noIndex) { %>
+      <meta name="robots" content="noindex" />
+    <% } %>
     <%~ it.headTags %>
     <% it.metaAttributes.forEach((metaAttribute) => { %>
       <%~ metaAttribute %>

diff --git a/packages/docusaurus/src/commands/start.ts b/packages/docusaurus/src/commands/start.ts
@@ -101,6 +101,7 @@ export default async function start(
         inject: false,
         filename: 'index.html',
         title: siteConfig.title,
+        noIndex: siteConfig.noIndex,
         headTags,
         preBodyTags,
         postBodyTags,

diff --git a/packages/docusaurus/src/webpack/server.ts b/packages/docusaurus/src/webpack/server.ts
@@ -32,6 +32,7 @@ export default function createServerConfig({
     preBodyTags,
     postBodyTags,
     ssrTemplate,
+    siteConfig: {noIndex},
   } = props;
   const config = createBaseConfig(props, true, minify);
 
@@ -72,6 +73,7 @@ export default function createServerConfig({
           postBodyTags,
           onLinksCollected,
           ssrTemplate,
+          noIndex,
         },
         paths: ssgPaths,
       }),

diff --git a/website/docs/api/docusaurus.config.js.md b/website/docs/api/docusaurus.config.js.md
@@ -84,7 +84,7 @@ module.exports = {
 
 - Type: `boolean`
 
-Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.
+this option adds `<meta name="robots" content="noindex">` in pages, to tell search engines to avoid indexing your site (more information [here](https://moz.com/learn/seo/robots-meta-directives)).
 
 Example:
 

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -46,7 +46,6 @@ module.exports = {
   tagline: 'Build optimized websites quickly, focus on your content',
   organizationName: 'facebook',
   projectName: 'docusaurus',
-  noIndex: false,
   baseUrl,
   url: 'https://v2.docusaurus.io',
   onBrokenLinks: isVersioningDisabled ? 'warn' : 'throw',