Add option to pick PDF margins and format (A4/A3/etc.)

README.md

@@ -55,6 +55,8 @@ npx docusaurus-pdf from-build-config
 - Mandatory: `dirPath` which points to the build directory created with `docusaurus build`.
 - Mandatory: `firstDocPagePath` is the URL path segment (without `baseUrl`) of your first docs page you whish to have included in the PDF.
 - Optional: If you have a `baseUrl` configured in your `docusaurus.config.js` then pass this value as `baseUrl`.
+- Optional: You can specify larger/smaller margins, e.g. `--margin "1cm 1.5cm 1cm 2cm"` (order top right bottom left, like the css margin field).
+- Optional: You can change the size of the paper by using `--format`, e.g. `--format A3`
 - Note: There is a optional parameter to set a custom filename. You can see further details using `npx docusaurus-pdf from-build --help`.
 
 ## Docker usage

bin/index.js

@@ -10,22 +10,55 @@ const {
   generatePdfFromBuildWithConfig,
 } = require("../lib");
 
+function generatePdfOptions({ sandbox, margin, format, printBackground }) {
+  return {
+    puppeteerArgs: sandbox ? [] : ["--no-sandbox"],
+    puppeteerPdfOpts: { margin, format, printBackground },
+  };
+}
+
+function parseMargin(marginString) {
+  const matches = [...marginString.match(/\d+\w{0,2}/g)];
+  if (matches.length !== 4) {
+    throw Error(
+      `Was expecting exactly 4 margin specifiers, instead got ${matches.length}. Margin specifier was "${marginString}".`
+    );
+  }
+  const [top, right, bottom, left] = matches;
+  return { top, right, bottom, left };
+}
+
 program
   .version(require("../package.json").version)
   .name("docusaurus-pdf")
   .usage("<initialDocsUrl> [filename]")
-  .description("Generate PDF from initial docs url")
-  .arguments("<initialDocsUrl> [filename]")
-  .action((initialDocsUrl, filename) => {
-    generatePdf(initialDocsUrl, filename)
-      .then(() => {
-        console.log(chalk.green("Finish generating PDF!"));
-        process.exit(0);
-      })
-      .catch((err) => {
-        console.error(chalk.red(err.stack));
-        process.exit(1);
-      });
+  .description("Generate a PDF from a docusaurus website")
+  .option("--no-sandbox", "Start puppeteer with --no-sandbox flag")
+  .option(
+    "--margin <margin>",
+    "Set margins of the pdf document with units in order top, right, bottom, left (units px,in,mm,cm)",
+    parseMargin,
+    "25px 35px 25px 35px"
+  )
+  .option(
+    "--format <format>",
+    "Set the size of the page, e.g. (A4, Letter)",
+    "A4"
+  )
+  .option("--no-print-background", "Disable printing the page background");
+
+program
+  .command("from-website <initialDocsUrl> [filename]", {
+    isDefault: true,
+  })
+  .description("Generate PDF from an already hosted website")
+  .action(async (initialDocsUrl, filename = "docusaurus.pdf") => {
+    await generatePdf(
+      initialDocsUrl,
+      filename,
+      generatePdfOptions(program.opts())
+    );
+    console.log(chalk.green("Finish generating PDF!"));
   });
 
 program
@@ -36,34 +69,25 @@ program
     "Specify your file name.",
     "docusaurus.pdf"
   )
-  .option("--no-sandbox", "Start puppeteer with --no-sandbox flag")
-  .action((dirPath, firstDocPagePath, baseUrl, options) => {
-    const puppeteerArgs = options.sandbox ? [] : ["--no-sandbox"];
-    generatePdfFromBuildSources(
+  .action(async (dirPath, firstDocPagePath, baseUrl, { outputFile }) => {
+    await generatePdfFromBuildSources(
       dirPath,
       firstDocPagePath,
       baseUrl,
-      options.outputFile,
-      puppeteerArgs
-    )
-      .then(() => {
-        console.log(chalk.green("Finish generating PDF!"));
-        process.exit(0);
-      })
-      .catch((err) => {
-        console.error(chalk.red(err.stack));
-        process.exit(1);
-      });
+      outputFile,
+      generatePdfOptions(program.opts())
+    );
+    console.log(chalk.green("Finish generating PDF!"));
   });
 
 program
   .command("from-build-config [dirPath]")
   .description(
-    "Generate PDF from a docusaurs build artifact, loading from a docusaurus.config.js file"
+    "Generate PDF from a docusaurus build artifact, loading from a docusaurus.config.js file"
   )
   .option(
     "--site-dir <dir>",
-    "The full path for the docusuarus site directory, relative to the current workspace." +
+    "The full path for the docusaurus site directory, relative to the current workspace." +
       " Equivalent to the siteDir in `npx docusaurus build`",
     "./"
   )
@@ -72,21 +96,26 @@ program
     "Specify your file name",
     "docusaurus.pdf"
   )
-  .option("--no-sandbox", "Start puppeteer with --no-sandbox flag")
-  .action((dirPath = "build", { siteDir, outputFile, sandbox }) => {
-    const puppeteerArgs = sandbox ? [] : ["--no-sandbox"];
-    generatePdfFromBuildWithConfig(siteDir, dirPath, outputFile, puppeteerArgs)
-      .then(() => {
-        console.log(chalk.green("Finish generating PDF!"));
-        process.exit(0);
-      })
-      .catch((err) => {
-        console.error(chalk.red(err.stack));
-        process.exit(1);
-      });
+  .action(async (dirPath = "build", { siteDir, outputFile }) => {
+    await generatePdfFromBuildWithConfig(
+      siteDir,
+      dirPath,
+      outputFile,
+      generatePdfOptions(program.opts())
+    );
+    console.log(chalk.green("Finish generating PDF!"));
   });
 
-program.parse(process.argv);
+async function main() {
+  try {
+    await program.parseAsync(process.argv);
+  } catch (error) {
+    console.error(chalk.red(error.stack));
+    process.exit(1);
+  }
+}
+
+main();
 
 if (!process.argv.slice(2).length) {
   program.outputHelp();