Skip to content

Commit b4d66c2

Browse files
committed
Update README with theming documentation and examples
- Add Theming section explaining --theme CLI option - Add Examples section with links to all generated PDFs - Include link to colorful test theme as reference - Document custom CSS styling capabilities
1 parent fa2773a commit b4d66c2

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,31 @@ You can control which pages from an embedded PDF are included using simple opera
5959

6060
You cannot specify both `!=` and `=` for the same PDF (the tool will throw an error).
6161

62+
## Theming
63+
64+
Customize the appearance of your generated PDFs by providing a custom CSS file:
65+
66+
```bash
67+
document-stitcher input.md output.pdf --theme custom-theme.css
68+
```
69+
70+
The CSS file will be applied to the HTML before PDF generation, giving you full control over fonts, colors, spacing, and layout. See [test_theme.scss](tests/fixtures/theme/test_theme.scss) for an example of a colorful theme.
71+
72+
## Examples
73+
74+
Here are some example PDFs generated from the test fixtures:
75+
76+
- [Basic Markdown](test-output/integration/basic-generated.pdf) - Simple markdown rendering
77+
- [Combined Features](test-output/integration/combined-generated.pdf) - Multiple markdown features
78+
- [Embedded PDFs](test-output/integration/embed-pdf-generated.pdf) - PDF embedding functionality
79+
- [Images](test-output/integration/images-generated.pdf) - Image inclusion and sizing
80+
- [Math Expressions](test-output/integration/math-generated.pdf) - LaTeX math rendering
81+
- [Multi-page PDFs](test-output/integration/multi_page_full-generated.pdf) - Full PDF embedding
82+
- [Page Selection](test-output/integration/multi_page_include-generated.pdf) - Selective page inclusion
83+
- [Page Skipping](test-output/integration/multi_page_skip-generated.pdf) - Page exclusion
84+
- [Page Breaks](test-output/integration/pagebreaks-generated.pdf) - Manual page breaks
85+
- [Custom Theme](test-output/integration/themed-generated.pdf) - Colorful themed output
86+
6287
## License
6388

6489
This project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)