Skip to content

Minor correction to documentation #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
excid3 merged 2 commits into from
Aug 1, 2025
Merged

Minor correction to documentation #71

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30d03b6
Minor corrections to documentation
Viktor-Ivliev Aug 1, 2025
c504e8c
Update README.md
excid3 Aug 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ end
You can also customize which template is rendered. This will render the template to string with `render_to_string` in Rails, then pass it along to Chrome. For example, you can add headers and footers using `pdf_options` and use a specific layout:

```ruby
# In your controller action
render ferrum_pdf: {
display_header_footer: true,
header_template: FerrumPdf::DEFAULT_HEADER_TEMPLATE,
Expand Down Expand Up @@ -127,6 +128,7 @@ end
You can also customize which template is rendered. This will render the template to string with `render_to_string` in Rails, then pass it along to Chrome.

```ruby
# In your controller action
render ferrum_screenshot: {
format: "png" # or "jpeg"
quality: nil # Integer 0-100 works for jpeg only
Expand All @@ -137,7 +139,7 @@ render ferrum_screenshot: {
background_color: nil # Ferrum::RGBA.new(0, 0, 0, 0.0)
},
layout: "example",
template: "example"
template: "example",
disposition: :inline,
filename: "example.png"
```
Expand Down