README file from
GithubSearch Report PDF
Generate clean, corporate-style A4 PDF reports directly from your active search results, featuring an executive summary table of shared frontmatter properties, pending tasks (- [ ]), and clickable internal links to individual note chapters.
Key features
- Direct search panel integration: Adds a one-click PDF export icon right in the native Search bar (plus a Command Palette action) preserving your exact search sort order.
- Automatic common-property detection: Scans frontmatter YAML and inline
#tagsacross matching notes, ranks properties by frequency (for exampletags 16/16,status 12/16), and pre-selects shared columns for the initial summary table. - Open tasks listing (
- [ ]): Extracts unchecked tasks from each matching note and lists them directly inside the initial summary table. - Interactive internal PDF navigation:
- Every note in the initial summary table links directly to its corresponding chapter inside the PDF.
- Every chapter ends with a
↑ Back to initial summarylink jumping back to the index table. - Cross-references (
[[Another note]]) between notes included in the same report automatically become internal PDF chapter links.
- Smart A4 pagination:
- Packs consecutive short notes onto the same A4 page when the next note fits completely in the remaining space.
- Automatically starts the next note at the top of a fresh A4 page whenever it would be split across pages.
- Corporate printable layout: Crisp white A4 styling independent of dark/light editor themes, with YAML metadata cards per chapter, embedded local vault images, running headers, and
Page X of Yfooters. - Bilingual UI (
en/es): Automatically adapts to English or Spanish based on your language setting.
Usage
- Open the core Search panel and run any search query (for example
tag:#Estefaníaortask-todo:""). - Click the Export search results to PDF report icon in the search bar (or open the Command Palette and run Search Report PDF: Export current search results to PDF).
- Review or customize the report title, summary table columns, smart A4 pagination, and selected notes in the configuration modal.
- Click Generate PDF... and choose where to save the file.
Development and build
With Node.js (standard workflow & GitHub Actions)
npm install
npm run build
Without Node.js (local Python bundler & vault deployment)
If Node.js is not installed on your workstation, you can bundle src/*.ts into main.js and optionally deploy directly to a local vault using Python 3:
python scripts/build_and_deploy.py
python scripts/build_and_deploy.py --vault "C:\path\to\your\vault"