satori
svg2pdf.js
satori | svg2pdf.js | |
---|---|---|
36 | 5 | |
10,146 | 627 | |
2.0% | 2.6% | |
7.0 | 5.6 | |
about 2 months ago | 27 days ago | |
TypeScript | TypeScript | |
Mozilla Public License 2.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
satori
-
Creating an OG image using React and Netlify Edge Functions
View on GitHub
-
Show HN: Dropflow, a CSS layout engine for node or <canvas>
I've used satori [0] on the backend with TypeScript/Deno to render JSX as an SVG (which is then rendered to a PNG).
Satori is meant for rendering Open Graph images (e.g. the little images that come up when you post a link on Twitter/Slack/Facebook), but I found that it works well for rendering arbitrary images. It supports a subset of modern CSS, including flexbox.
My use case is posting match reports for League of Legends into a Discord text channel, e.g. person X just played a match, here are their stats.
It's quite nice because there are almost zero server-side native dependencies (the one exception is the library to convert svg -> png requires some native libraries).
Here's what a match report looks like: [1]
Here's an example of what the JSX looks like: [2]
[0]: https://github.com/vercel/satori
[1]: https://github.com/shepherdjerred/glitter/blob/main/assets/p...
[2]: https://github.com/shepherdjerred/glitter/blob/main/packages...
-
Learn SVG with 25 examples – How to code images in HTML
Another way is to write HTML/CSS and use satori [0] to convert that to SVG. It's meant for Open Graph images (the images that show up when you link a site in Discord, Slack, Twitter, etc.), but it works quite well for anything.
This is obviously not as flexible as true SVG, but it is familiar to author for anyone who's written a React application. I've used it on the backend to generate match reports for League of Legends [1]
[0]: https://github.com/vercel/satori
[1]: https://github.com/shepherdjerred/glitter-boys
-
Open-graph image generation with Astro
Install the @vercel/og package. This library is designed to convert React code into PNG images. It is built on Satori, a library that converts HTML and CSS into SVGs.
-
All you need to know about metadata in next.js 13 by Anik Routh
Examples are available in the Vercel OG Playground.
-
Making Dynamic Website Thumbnail
In this version, we no longer use Puppeteer to capture HTML and return images. Instead, we utilize the @vercel/og library, which employs Satori as its core engine. Satori is a library that converts HTML and CSS into SVG.
-
Generate Dynamic Open Graph and Twitter Images in Next.js
This is made possible thanks to the Dynamic Open Graph Image Generation feature introduced with Next.js version 13.3, and the new Metadata API. In summary, it involves generating images using code (in our case, TSX, HTML, and CSS) with the help of the libraries @vercel/og (already integrated in the App router) and Satori. Satori converts HTML and CSS to SVG, and then resvg-js converts the SVG to a PNG image. All of this in just a few milliseconds!
-
How to generate dynamic OG image using new NextJs with App directory
Here you are returning an ImageResponse instead of the Response, alternatively you can also extend the request and response web api using 'NextRequest' and 'NextRespone', to do that you can import them using import { NextResponse, NextRequest } from 'next/server';, though for this example it is not required. Now if you refresh your browser you will get an image generated by your 'route.js' at request time. Well we are almost done. You can render whatever dynamic data in your image you want and customize your image using og playground, you can even generate 'SVG' on request as the og image. For this example we will fetch a random number from random.org api, then we will use that number as an id and fetch an image from Lorem Picsum, with the same image url we will fetch the description for the image from the Alt Image Generator and generate an image on request with the image that we fetched and the description we have fetched and use it in a design to create the og image. Kind of like that.
-
x-satori --- using Vue file to generate Open Graph SVG or PNG by satori
Use Vue files to generate SVG images by Satori. The image can be generated by running ESM script or CLI.
-
Printing Django view with chart.js graphs, in a PDF
I'm not familiar with it but looks like it's made with nodejs, node uses the same js engine used by chrome, node renders the template and converts it to plain html/css and then they use this library to convert it to png but in the library github page it says that they don't support everything so it's kinda similar to xhtml2pdf or weasyprint
svg2pdf.js
-
Is node the right choice for HTML to PDF conversion?
You should check out Vercel's Satori package. You can generate SVGs from JSX without a chromium instance. Pair that with something like https://github.com/yWorks/svg2pdf.js/ and you might be onto something.
- Forking Chrome to Turn HTML into SVG
-
What's a good way to deliver printable reports?
If you need to print to exact dimensions, you MUST use PDF. This was what i needed, so I draw everything to an SVG, and made sure that my units were in "pt" (that is 1px = 1/72inch). When creating the PDF, I specified that the units were in "pt" and used https://github.com/yWorks/svg2pdf.js/ to convert the SVG. Note that this has major disadvantages. SVG does not support word wrap by default; you'll have to write your own. You'll also have to get users to specify a paper size in your app. Again, test, test, test. If you want to preview the PDF, not all browsers can display PDF natively (looking at you Android)! Some browsers won't print exact size even in PDF (Android). Some browsers will reduce page margins if printing from an inline iframe preview (Safari). You need annoying workarounds. Like downloading instead of previewing the file on Android, or making sure to always open a new tab on Safari.
-
Creating a PDF
I used it with https://github.com/yWorks/svg2pdf.js/ which makes it easy to draw diagrams too.
-
Guest WiFi using a QR code
Hmm, after tinkering around a bit, I think according to https://github.com/yWorks/svg2pdf.js/issues/82 , the mask element in the giraffe SVGs is not supported in the PDF converter. It is just dropped, leafing the qraffe rather qr-less.
But I sadly know neither svg enough to think up an alternative approach, or a JS/TS dev enough to see if there are other libraries.
What are some alternatives?
Tailwind CSS - A utility-first CSS framework for rapid UI development.
pdf-lib - Create and modify PDF documents in any JavaScript environment
html2canvas - Screenshots with JavaScript
canvas2svg - Translates HTML5 Canvas draw commands to SVG
tremor - React components to build charts and dashboards
jsPDF - Client-side JavaScript PDF generation for everyone.
dungeonz - Everything for the game Rogueworld. [Moved to: https://github.com/Arcanorum/rogueworld]
SVG-to-PDFKit - Insert SVG into a PDF document created with PDFKit
react-pdf - 📄 Create PDF files using React
yoga - Yoga is an embeddable layout engine targeting web standards.
TypeStat - Converts JavaScript to TypeScript and TypeScript to better TypeScript. 🧫