Files
upstream-mattermost/docs/pdf/scripts/build-page-pdf.mjs
upstream-mirror 240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)
2026-09-16 00:29:55 +05:00

76 lines
2.6 KiB
JavaScript

#!/usr/bin/env node
/*
* Capture a single docs page to PDF, applying the brand-aligned print
* stylesheet. Used both for on-demand single-page PDF (the per-page
* "Download PDF" button) and as the unit primitive that the book
* builder concatenates.
*
* Usage:
* node pdf/scripts/build-page-pdf.mjs <url> <output.pdf>
* node pdf/scripts/build-page-pdf.mjs http://localhost:3000/api pdf/build/api-overview.pdf
*
* Pre-req: the docs site is built (npm run build) and being served
* either by `npm run serve` or some other static server. Pass the URL
* the page is reachable at.
*/
import puppeteer from 'puppeteer';
import {readFileSync, mkdirSync, existsSync} from 'node:fs';
import {dirname, resolve} from 'node:path';
async function main() {
const [url, output] = process.argv.slice(2);
if (!url || !output) {
console.error('usage: build-page-pdf.mjs <url> <output.pdf>');
process.exit(2);
}
const printCss = readFileSync(new URL('../styles/print.css', import.meta.url), 'utf8');
mkdirSync(dirname(resolve(output)), {recursive: true});
console.log(`[pdf] launching headless Chromium…`);
const browser = await puppeteer.launch({
headless: 'new',
args: ['--no-sandbox', '--font-render-hinting=none'],
});
try {
const page = await browser.newPage();
page.on('console', (m) => console.log(`[pdf:browser] ${m.type()}: ${m.text()}`));
page.on('pageerror', (e) => console.error(`[pdf:browser-error] ${e.message}`));
console.log(`[pdf] loading ${url}`);
await page.goto(url, {waitUntil: 'networkidle0', timeout: 60_000});
// Apply the print stylesheet (so it lays out for paper while still
// running with media:screen — works around quirks where some
// Docusaurus chrome only renders for screen).
await page.addStyleTag({content: printCss});
await page.emulateMediaType('print');
// Give web fonts time to settle so headlines don't fall back.
await page.evaluateHandle('document.fonts.ready');
console.log(`[pdf] rendering PDF → ${output}`);
await page.pdf({
path: resolve(output),
format: 'A4',
printBackground: true,
preferCSSPageSize: true,
margin: {top: '22mm', right: '18mm', bottom: '24mm', left: '18mm'},
displayHeaderFooter: false, // headers/footers come from @page in print.css
});
const fs = await import('node:fs/promises');
const {size} = await fs.stat(resolve(output));
console.log(`[pdf] done — ${(size / 1024).toFixed(1)} KB`);
} finally {
await browser.close();
}
}
main().catch((e) => {
console.error('[pdf] fatal:', e);
process.exit(1);
});