[CLI FEATURE] Add file path headers to each file content in the generated PDF output

[JaosnHsieh]

💡 Feature Description

Add file path headers to each file content in the generated PDF output to improve content traceability and navigation.

Problem and Motivation

Currently, the tool generates PDFs without showing the original file paths [output.pdf]. This makes it difficult to track the source location of code snippets and content within the repository structure. Users need clear file path information to understand the organizational context of each file.

Proposed Solution

Add a prominent header section at the beginning of each file's content in the PDF that clearly displays the full file path. The header should be visually distinct and consistently formatted.

Example Usage

npx repo2pdf ./my-project --show-filepath

Expected Impact

• Improved content navigation and traceability in generated PDFs
• Better understanding of repository structure
• Easier reference and documentation of code locations
• Enhanced usability for code reviews and documentation

Implementation Ideas

Based on the existing code [output.pdf]:

1. Before writing file content, add a new section that prints the full file path
2. Use doc.font() and doc.fontSize() to style the filepath header distinctly
3. Add the filepath header right after doc.addPage()
4. Implement as an optional flag with a default value of true
5. Consider adding a horizontal line separator after the filepath for better visual separation

Related Documentation

• Update main README.md to document the new flag
• Add examples showing filepath headers in documentation
• Update usage documentation with new option
• Add configuration options documentation if filepath display can be customized

Additional Context

This feature will particularly benefit teams doing code reviews and documentation, making it easier to reference specific files and understand the repository structure from the PDF output.

Related Issues/PRs

None currently linked

Willingness to Contribute

• No, I'm just suggesting an idea

[BankkRoll]

Thanks for opening a feature request! The webapp allows for alot of extra features if you need it, specially file headers as well as line numbers, TOC and much more!! One time purchase to access @ https://repo2pdf.site