From 1ca4fb50fe8f5953949d1b14c73bd6758277695c Mon Sep 17 00:00:00 2001 From: John Reilly Date: Wed, 12 Oct 2022 16:45:56 +0100 Subject: [PATCH] feat(core): siteConfig.headTags API to render extra tags in document head (#8151) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sébastien Lorber --- packages/docusaurus-types/src/config.d.ts | 9 ++- .../__snapshots__/config.test.ts.snap | 5 ++ .../__snapshots__/index.test.ts.snap | 1 + .../server/__tests__/configValidation.test.ts | 68 +++++++++++++++++++ .../docusaurus/src/server/configValidation.ts | 16 +++++ .../src/server/plugins/synthetic.ts | 3 +- website/docs/api/docusaurus.config.js.md | 24 +++++++ 7 files changed, 124 insertions(+), 2 deletions(-) diff --git a/packages/docusaurus-types/src/config.d.ts b/packages/docusaurus-types/src/config.d.ts index 77fd2126be..8421b480f8 100644 --- a/packages/docusaurus-types/src/config.d.ts +++ b/packages/docusaurus-types/src/config.d.ts @@ -8,7 +8,7 @@ import type {RuleSetRule} from 'webpack'; import type {Required as RequireKeys, DeepPartial} from 'utility-types'; import type {I18nConfig} from './i18n'; -import type {PluginConfig, PresetConfig} from './plugin'; +import type {PluginConfig, PresetConfig, HtmlTagObject} from './plugin'; export type ReportingSeverity = 'ignore' | 'log' | 'warn' | 'throw'; @@ -192,6 +192,13 @@ export type DocusaurusConfig = { * @default ["static"] */ staticDirectories: string[]; + /** + * An array of tags that will be inserted in the HTML ``. + * + * @see https://docusaurus.io/docs/api/docusaurus-config#head + * @default [] + */ + headTags: HtmlTagObject[]; /** * An array of scripts to load. The values can be either strings or plain * objects of attribute-value maps. The `