feat(v2): allow users to specify a custom ssr HTML template

facebook · Sep 1, 2020 · 27e4f32 · 27e4f32
1 parent 0d018a8
commit 27e4f32
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 8 deletions.
diff --git a/packages/docusaurus-types/src/index.d.ts b/packages/docusaurus-types/src/index.d.ts
@@ -41,6 +41,7 @@ export interface DocusaurusConfig {
  [key: string]: unknown;
  }
  )[];
+ ssrTemplate?: string;
  stylesheets?: (
  | string
  | {
@@ -106,6 +107,7 @@ export interface LoadContext {
  siteConfig: DocusaurusConfig;
  outDir: string;
  baseUrl: string;
+ ssrTemplate?: string;
 }
 
 export interface InjectedHtmlTags {

diff --git a/packages/docusaurus/src/client/serverEntry.js b/packages/docusaurus/src/client/serverEntry.js
@@ -26,19 +26,18 @@ import {
  createStatefulLinksCollector,
  ProvideLinksCollector,
 } from './LinksCollector';
-import ssrTemplate from './templates/ssr.html.template';
 
 // eslint-disable-next-line no-restricted-imports
 import {memoize} from 'lodash';
 
-const getCompiledSSRTemplate = memoize(() => {
- return eta.compile(ssrTemplate.trim(), {
+const getCompiledSSRTemplate = memoize((template) => {
+ return eta.compile(template.trim(), {
  rmWhitespace: true,
  });
 });
 
-function renderSSRTemplate(data) {
- const compiled = getCompiledSSRTemplate();
+function renderSSRTemplate(ssrTemplate, data) {
+ const compiled = getCompiledSSRTemplate(ssrTemplate);
  return compiled(data, eta.defaultConfig);
 }
 
@@ -51,6 +50,7 @@ export default async function render(locals) {
  postBodyTags,
  onLinksCollected,
  baseUrl,
+ ssrTemplate,
  } = locals;
  const location = routesLocation[locals.path];
  await preload(routes, location);
@@ -90,7 +90,7 @@ export default async function render(locals) {
  const stylesheets = (bundles.css || []).map((b) => b.file);
  const scripts = (bundles.js || []).map((b) => b.file);
 
- const renderedHtml = renderSSRTemplate({
+ const renderedHtml = renderSSRTemplate(ssrTemplate, {
  appHtml,
  baseUrl,
  htmlAttributes: htmlAttributes || '',

diff --git a/packages/docusaurus/src/server/configValidation.ts b/packages/docusaurus/src/server/configValidation.ts
@@ -81,6 +81,7 @@ const ConfigSchema = Joi.object({
  // See https://github.com/facebook/docusaurus/issues/3378
  .unknown(),
  ),
+ ssrTemplate: Joi.string(),
  stylesheets: Joi.array().items(
  Joi.string(),
  Joi.object({

diff --git a/packages/docusaurus/src/server/index.ts b/packages/docusaurus/src/server/index.ts
@@ -7,6 +7,7 @@
 
 import {generate} from '@docusaurus/utils';
 import path, {join} from 'path';
+import ssrDefaultTemplate from '../client/templates/ssr.html.template';
 import {
  BUILD_DIR_NAME,
  CONFIG_FILE_NAME,
@@ -42,14 +43,15 @@ export function loadContext(
  const outDir = customOutDir
  ? path.resolve(customOutDir)
  : path.resolve(siteDir, BUILD_DIR_NAME);
- const {baseUrl} = siteConfig;
+ const {baseUrl, ssrTemplate} = siteConfig;
 
  return {
  siteDir,
  generatedFilesDir,
  siteConfig,
  outDir,
  baseUrl,
+ ssrTemplate,
  };
 }
 
@@ -71,7 +73,7 @@ export async function load(
 ): Promise<Props> {
  // Context.
  const context: LoadContext = loadContext(siteDir, customOutDir);
- const {generatedFilesDir, siteConfig, outDir, baseUrl} = context;
+ const {generatedFilesDir, siteConfig, outDir, baseUrl, ssrTemplate} = context;
 
  // Plugins.
  const pluginConfigs: PluginConfig[] = loadPluginConfigs(context);
@@ -235,6 +237,7 @@ ${Object.keys(registry)
  headTags,
  preBodyTags,
  postBodyTags,
+ ssrTemplate: ssrTemplate || ssrDefaultTemplate,
  };
 
  return props;

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

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -7,6 +7,7 @@
 
 const path = require('path');
 const versions = require('./versions.json');
+const ssrTemplate = require('./test').default;
 
 const allDocHomesPaths = [
  '/docs/',
@@ -37,6 +38,7 @@ module.exports = {
  description:
  'An optimized site generator in React. Docusaurus helps you to move fast and write content. Build documentation websites, blogs, marketing pages, and more.',
  },
+ ssrTemplate,
  themes: ['@docusaurus/theme-live-codeblock'],
  plugins: [
  [