Skip to content

This is a Node.js and Puppeteer-based command-line tool designed to capture and merge Docusaurus website documentation content into a single PDF file. It aims to automate documentation archiving, offline reading, or generating printable versions.

License

Notifications You must be signed in to change notification settings

fastone-open/docusaurus-docs-to-pdf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docusaurus To PDF Converter

Introduction

This is a Node.js and Puppeteer-based command-line tool designed to capture and merge Docusaurus website documentation content into a single PDF file. It aims to automate documentation archiving, offline reading, or generating printable versions.

PDF example

You can find a sample PDF generated by this tool at doccusaurus.pdf in the repository. This provides a quick preview of the output.

Features

  • Full Site PDF Export: Exports all documentation pages from a Docusaurus site into a single, cohesive PDF file.
  • Concurrent Processing: Leverages Puppeteer's concurrency capabilities to speed up the page content fetching process.
  • Custom Cover Page: Supports adding a custom PDF cover page using either a URL or a local file path.
  • Automatic Table of Contents (TOC) Generation: Automatically generates a clickable PDF table of contents based on the Docusaurus sidebar structure.
  • Navigable Internal Links: Rewrites all internal links within the documentation so they remain clickable and navigable in a PDF reader.
  • Configurable Margins: Supports adjusting PDF page margins via command-line arguments.

Installation

npm install -g docusaurus-docs-to-pdf
# or
yarn global add docusaurus-docs-to-pdf

Usage

Run the script from the command line and pass the appropriate arguments.

Command-Line Arguments

docusaurus-docs-to-pdf -h
# or
npx docusaurus-docs-to-pdf -h

Examples

Generate pdf from Docusaurus website

docusaurus-docs-to-pdf --docs-url https://docusaurus.io/docs --pdf-path docusaurus.pdf --pdf-cover-image https://docusaurus.io/img/docusaurus_keytar.svg
# or
npx docusaurus-docs-to-pdf --docs-url https://docusaurus.io/docs --pdf-path docusaurus.pdf --pdf-cover-image https://docusaurus.io/img/docusaurus_keytar.svg

About

This is a Node.js and Puppeteer-based command-line tool designed to capture and merge Docusaurus website documentation content into a single PDF file. It aims to automate documentation archiving, offline reading, or generating printable versions.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published