feat: support specify an outline container selector

Author: condorheroblog

packages/vuepress-plugin-export-pdf-core/package.json

@@ -55,7 +55,7 @@
 		"cac": "^6.7.14",
 		"envinfo": "^7.8.1",
 		"fs-extra": "^11.1.1",
-		"html-export-pdf-cli": "^1.0.3",
+		"html-export-pdf-cli": "^1.1.0",
 		"multimatch": "^6.0.0",
 		"ora": "^6.3.0",
 		"pdfjs": "^2.4.7",

packages/vuepress-plugin-export-pdf-core/src/generatePdf.ts

@@ -23,10 +23,11 @@ export interface IGeneratePdfOptions {
 	pdfOptions?: PDFOptions
 	pdfOutlines?: boolean
 	urlOrigin?: string
+	outlineContainerSelector?: string
 }
 
 /**
- * Generate PDF from VuePress dev server.
+ * Generate PDF from VuePress or VitePress dev server.
  * @param param1 - IGeneratePdfOptions
  */
 export const generatePdf = async ({
@@ -42,7 +43,8 @@ export const generatePdf = async ({
 	pdfOutlines,
 	routePatterns,
 	puppeteerLaunchOptions,
-// eslint-disable-next-line sonarjs/cognitive-complexity
+	outlineContainerSelector,
+	// eslint-disable-next-line sonarjs/cognitive-complexity
 }: IGeneratePdfOptions) => {
 	const tempPdfDir = join(tempDir, "pdf");
 	fse.ensureDirSync(tempPdfDir);
@@ -70,7 +72,7 @@ export const generatePdf = async ({
 	const singleBar = createProgress();
 	singleBar.start(normalizePages.length);
 
-	const printer = new Printer();
+	const printer = new Printer({ outlineContainerSelector });
 	await printer.setup(puppeteerLaunchOptions);
 
 	for (const { location, pagePath, title } of normalizePages) {
@@ -114,7 +116,8 @@ export const generatePdf = async ({
 		});
 		await writeFileSafe(pagePath, data);
 
-		singleBar.increment(1, { headTitle: title });
+		const headTitle = title || await page.title();
+		singleBar.increment(1, { headTitle });
 	}
 
 	singleBar.stop();

packages/vuepress-plugin-export-pdf-core/src/types.ts

@@ -8,7 +8,7 @@ export interface CommandOptions {
 }
 
 export interface Page {
-	title: string
+	title?: string
 	key: string
 	path: string
 }

packages/vuepress-plugin-export-pdf-core/src/utils/checkEnv.ts

@@ -5,23 +5,30 @@
 import semver from "semver";
 
 /**
- * Check if Node version meets VuePress requirement and Vuepress meets plugin VuePress.
+ * Ensure that current Node version matches App's Node version and App's version matches peerVersion
+ *
+ * @param {string} appName - App's name.
+ * @param {string} nodeVersion - The minimum required version of Node.
+ * @param {string} appVersion - The version number of App.
+ * @param {string} peerVersion - The required version number of the plugin.
+ * @returns {void}
+ * @throws {Error} If the environment does not meet the minimum requirements.
  */
 
-export function checkEnv(nodeVersion: string, appVersion: string, peerVersion: string) {
+export function checkEnv(appName = "VuePress", nodeVersion: string, appVersion: string, peerVersion: string) {
 	if (!semver.satisfies(process.version, nodeVersion, { includePrerelease: true })) {
 		console.error(
-			"\n[vuepress] minimum Node version not met:"
-      + `\nYou are using Node ${process.version}, but VuePress `
+      `\n[${appName}] minimum Node version not met:`
+      + `\nYou are using Node ${process.version}, but ${appName} `
       + `requires Node ${nodeVersion}.\nPlease upgrade your Node version.\n`,
 		);
 		process.exit(1);
 	}
 
 	if (!semver.satisfies(appVersion, peerVersion, { includePrerelease: true })) {
 		console.error(
-			"\n[vuepress] VuePress version not met:"
-      + `\nYou are using VuePress ${appVersion}, but plugin `
+      `\n[${appName}] version not met:`
+      + `\nYou are using ${appName} ${appVersion}, but plugin `
       + `requires ${peerVersion}.\nPlease check it.\n`,
 		);
 		process.exit(1);

packages/vuepress-plugin-export-pdf-core/src/utils/mergePDF.ts

@@ -7,7 +7,7 @@ interface IPage {
 	location: string
 	pagePath: string
 	url: string
-	title: string
+	title?: string
 }
 
 /**

packages/vuepress-plugin-export-pdf-v1/README.md

@@ -133,6 +133,8 @@ config options:
 - `pdfOptions` - [Valid options to configure PDF generation via Page.pdf()](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.pdfoptions.md) (default `{ format: 'A4 }`)
 - `pdfOutlines` - Keep PDF outlines/bookmarks(default `true`)
 - `urlOrigin`: Change the origin of the print url([How do I change the URL point to the localhost](https://github.com/condorheroblog/vuepress-plugin-export-pdf/issues/5))
+- `outlineContainerSelector`: Specify an outline container selector.
+
 ## PDF print style
 
 By default, `A4` paper is used for printing, The size of A4 paper is (8.27in x 11.7in), One inch is equal to ninety-six pixels: `1 in = 96 pixel (X)` ,the inch unit of A4 is converted to (793.92px x 1123.2px).

packages/vuepress-plugin-export-pdf-v1/src/serverApp.ts

@@ -56,6 +56,7 @@ export const serverApp = async (dir = "docs", commandOptions: ICommandOptions =
 		outFile = vuepressOutFile,
 		urlOrigin = commandOptions.urlOrigin,
 		pdfOutlines = commandOptions.pdfOutlines,
+		outlineContainerSelector,
 	} = userConfig;
 
 	const devContext = await dev({
@@ -93,6 +94,7 @@ export const serverApp = async (dir = "docs", commandOptions: ICommandOptions =
 			pdfOutlines,
 			routePatterns,
 			puppeteerLaunchOptions,
+			outlineContainerSelector,
 		});
 	}
 	catch (error) {

packages/vuepress-plugin-export-pdf-v1/src/types.ts

@@ -15,4 +15,5 @@ export interface UserConfig {
 	outDir?: string
 	pdfOutlines?: boolean
 	urlOrigin?: string
+	outlineContainerSelector?: string
 }

packages/vuepress-plugin-export-pdf-v2/README.md

@@ -113,6 +113,8 @@ config options:
 - `pdfOptions` - [Valid options to configure PDF generation via Page.pdf()](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.pdfoptions.md) (default `{ format: 'A4 }`)
 - `pdfOutlines` - Keep PDF outlines/bookmarks(default `true`)
 - `urlOrigin`: Change the origin of the print url([How do I change the URL point to the localhost](https://github.com/condorheroblog/vuepress-plugin-export-pdf/issues/5))
+- `outlineContainerSelector`: Specify an outline container selector.
+
 ## PDF print style
 
 By default, `A4` paper is used for printing, The size of A4 paper is (8.27in x 11.7in), One inch is equal to ninety-six pixels: `1 in = 96 pixel (X)` ,the inch unit of A4 is converted to (793.92px x 1123.2px).

packages/vuepress-plugin-export-pdf-v2/src/serverApp.ts

@@ -50,6 +50,7 @@ export const serverApp = async (dir = "docs", commandOptions: CommandOptions = {
 		outDir = vuepressOutDir,
 		urlOrigin = commandOptions.urlOrigin,
 		pdfOutlines = commandOptions.pdfOutlines,
+		outlineContainerSelector,
 	} = userConfig;
 
 	const devApp = createDevApp({
@@ -85,6 +86,7 @@ export const serverApp = async (dir = "docs", commandOptions: CommandOptions = {
 			pdfOutlines,
 			routePatterns,
 			puppeteerLaunchOptions,
+			outlineContainerSelector,
 		});
 	}
 	catch (error) {