This repository now includes automated PDF generation for all toolbox documentation using the docusaurus-plugin-papersaurus plugin.
- Automatic Generation: PDFs are automatically generated when a new release is published via GitHub Actions
- Manual Trigger: The workflow can also be manually triggered from the Actions tab
- Organized Output: PDFs are organized by toolbox type for easy access
The workflow generates PDFs for the following documentation:
- English documentation
- German documentation (Deutsch)
- French documentation (Français)
- Spanish documentation (Español)
- Arabian documentation
- ElectronicsBox
- InfinityBox
- DiscoveryFluorescence
- LightsheetBox
- QBox
- SeeedMicroscope
Generated PDFs are available in two ways:
- Release Assets: Attached to each GitHub release
- Workflow Artifacts: Available as artifacts from the GitHub Actions workflow
To manually generate PDFs locally (requires Chrome/Chromium):
- Install Chrome or Chromium browser
- Set environment variable:
export PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser - Enable PDF generation in
docusaurus.config.js:autoBuildPdfs: true - Run:
npm run build - PDFs will be generated in
build/pdfs/
The PDF generation workflow is located at .github/workflows/generate-pdfs.yml and:
- Installs required dependencies including Chrome
- Builds the documentation with PDF generation enabled
- Organizes PDFs by toolbox type
- Uploads artifacts and attaches to releases
- Plugin: docusaurus-plugin-papersaurus v2.0.3
- PDF Engine: Puppeteer with Chrome/Chromium
- Organization: Automated sorting by toolbox folder structure
- Trigger: Release events and manual workflow dispatch