Skip to content

Commit

Permalink
doc: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vanthome authored and Vilsol committed Apr 17, 2024
1 parent 9d67dc9 commit 2f7ef55
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 0 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
= PDF Rendering Service

https://github.com/restorecommerce/pdf-rendering-srv/actions/workflows/build.yaml[image:https://img.shields.io/github/actions/workflow/status/restorecommerce/pdf-rendering-srv/build.yaml?style=flat-square[Build Status]]
https://depfu.com/repos/github/restorecommerce/pdf-rendering-srv?branch=master[image:https://img.shields.io/depfu/dependencies/github/restorecommerce/pdf-rendering-srv?style=flat-square[Dependencies]]
https://coveralls.io/github/restorecommerce/pdf-rendering-srv?branch=master[image:https://img.shields.io/coveralls/github/restorecommerce/pdf-rendering-srv/master.svg?style=flat-square[Coverage Status]]

A microservice for PDF rendering from URLs.

Expand Down
2 changes: 1 addition & 1 deletion cfg/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@
"maskedProperty": "urn:restorecommerce:acs:names:obligation:maskedProperty"
}
}
}
}
10 changes: 6 additions & 4 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ A microservice for rendering PDFs from HTML using the Chromium browser.

* Good for any kind of content like receipts, invoices, reports.
* gRPC interface including health checks.
* Batch rendering.
* Return or upload render results to an S3 endpoint.
* Uses link:https://www.chromium.org/[Chromium] to render PDF.
* Supports various fonts out of the box and adding custom fonts.
Expand Down Expand Up @@ -69,7 +71,7 @@ grpcurl -plaintext -d '{
}
]
}
}' 127.0.0.1:50069 io.restorecommerce.pdf_rendering.PdfRenderingService.Render | jq -r '.individual.RenderingResponse[0].payload.pdf.data' | base64 -d > out.pdf
}' 127.0.0.1:50051 io.restorecommerce.pdf_rendering.PdfRenderingService.Render | jq -r '.individual.RenderingResponse[0].payload.pdf.data' | base64 -d > out.pdf
----

[#example_call_from_html]
Expand All @@ -91,7 +93,7 @@ grpcurl -plaintext -d '{
}
]
}
}' 127.0.0.1:50069 io.restorecommerce.pdf_rendering.PdfRenderingService.Render | jq -r '.individual.RenderingResponse[0].payload.pdf.data' | base64 -d > out.pdf
}' 127.0.0.1:50051 io.restorecommerce.pdf_rendering.PdfRenderingService.Render | jq -r '.individual.RenderingResponse[0].payload.pdf.data' | base64 -d > out.pdf
----

[#example_call_combine]
Expand All @@ -116,7 +118,7 @@ grpcurl -plaintext -d '{
}
]
}
}' 127.0.0.1:50069 io.restorecommerce.pdf_rendering.PdfRenderingService.Render | jq -r '.combined.payload.pdf.data' | base64 -d > combined.pdf
}' 127.0.0.1:50051 io.restorecommerce.pdf_rendering.PdfRenderingService.Render | jq -r '.combined.payload.pdf.data' | base64 -d > combined.pdf
----

[#example_s3]
Expand Down Expand Up @@ -149,7 +151,7 @@ grpcurl -plaintext -d '{
}
]
}
}' 127.0.0.1:50069 io.restorecommerce.pdf_rendering.PdfRenderingService.Render | jq
}' 127.0.0.1:50051 io.restorecommerce.pdf_rendering.PdfRenderingService.Render | jq
----

[#customization]
Expand Down

0 comments on commit 2f7ef55

Please sign in to comment.