feat: provide `transformHtml` hook (#1022)

pull/1028/head
Divyansh Singh 3 years ago committed by GitHub
parent 4b38736adf
commit 2b4b800618
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -173,7 +173,16 @@ export async function renderPage(
</html>`.trim()
const htmlFileName = path.join(config.outDir, page.replace(/\.md$/, '.html'))
await fs.ensureDir(path.dirname(htmlFileName))
await fs.writeFile(htmlFileName, html)
const transformedHtml = await config.transformHtml?.(html, htmlFileName, {
siteConfig: config,
siteData,
pageData,
title,
description,
head,
content
})
await fs.writeFile(htmlFileName, transformedHtml || html)
}
function resolvePageImports(

@ -16,7 +16,8 @@ import {
LocaleConfig,
DefaultTheme,
APPEARANCE_KEY,
createLangDictionary
createLangDictionary,
PageData
} from './shared'
import { resolveAliases, DEFAULT_THEME_PATH } from './alias'
import { MarkdownOptions } from './markdown/markdown'
@ -77,6 +78,23 @@ export interface UserConfig<ThemeConfig = any> {
* @param siteConfig The resolved configuration.
*/
buildEnd?: (siteConfig: SiteConfig) => Promise<void>
/**
* HTML transform hook: runs before writing HTML to dist.
*/
transformHtml?: (
code: string,
id: string,
ctx: {
siteConfig: SiteConfig
siteData: SiteData
pageData: PageData
title: string
description: string
head: HeadConfig[]
content: string
}
) => Promise<string | void>
}
export type RawConfigExports<ThemeConfig = any> =
@ -95,6 +113,7 @@ export interface SiteConfig<ThemeConfig = any>
| 'lastUpdated'
| 'ignoreDeadLinks'
| 'buildEnd'
| 'transformHtml'
> {
root: string
srcDir: string
@ -174,7 +193,8 @@ export async function resolveConfig(
shouldPreload: userConfig.shouldPreload,
mpa: !!userConfig.mpa,
ignoreDeadLinks: userConfig.ignoreDeadLinks,
buildEnd: userConfig.buildEnd
buildEnd: userConfig.buildEnd,
transformHtml: userConfig.transformHtml
}
return config

Loading…
Cancel
Save