Search Report PDF

by Javi
5
4
3
2
1
Score: 50/100

Description

Reviews

No reviews yet.

Stats

0
stars
25
downloads
0
forks
3
days
1
days
1
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
2
commits

README file from

Github

Search 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 #tags across matching notes, ranks properties by frequency (for example tags 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 summary link 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 Y footers.
  • Bilingual UI (en / es): Automatically adapts to English or Spanish based on your language setting.

Usage

  1. Open the core Search panel and run any search query (for example tag:#Estefanía or task-todo:"").
  2. 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).
  3. Review or customize the report title, summary table columns, smart A4 pagination, and selected notes in the configuration modal.
  4. 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"

License

MIT