Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ktmouk/markup-pdf-rs
Make a PDF file by writing kind of like HTML and CSS.
https://github.com/ktmouk/markup-pdf-rs
pdf rust
Last synced: 2 months ago
JSON representation
Make a PDF file by writing kind of like HTML and CSS.
- Host: GitHub
- URL: https://github.com/ktmouk/markup-pdf-rs
- Owner: ktmouk
- Created: 2023-01-03T03:58:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-03T06:24:49.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T01:54:35.587Z (3 months ago)
- Topics: pdf, rust
- Language: Rust
- Homepage:
- Size: 1.47 MB
- Stars: 15
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# markup-pdf-rs
The Rust library for making a PDF files by writing kind of like HTML and CSS.
Inspired by [Satori](https://github.com/vercel/satori) and [React-pdf](https://github.com/diegomura/react-pdf).
This library makes a PDF file with [taffy](https://github.com/DioxusLabs/taffy) and [printpdf](https://github.com/fschutt/printpdf).
> :warning: This library is a prototype so we don't recommend using it in production.
## Usage
```rust main.rs
use std::{
fs::{File},
io::BufWriter,
};
use markup_pdf_rs::{assets::Assets, document::Document, dom, style::Style};
use taffy::{
prelude::{Rect, Size},
style::{
Dimension::{self, Points},
FlexDirection, JustifyContent,
},
};
fn main() {
// Define styles like CSS used by XML.
let mut assets = Assets::default();
assets.styles.add(
// Specify the name of the style
// You can use this style by setting the `style` attribute to an element
// e.g. ``
"page",
Style {
// These styles are basically the same as taffy.
size: Size {
width: Points(210.0),
height: Points(297.0),
},
..Style::DEFAULT
},
);
assets.styles.add(
"main",
Style {
gap: Size {
width: Dimension::Auto,
height: Points(6.0),
},
flex_grow: 1.0,
flex_direction: FlexDirection::Column,
justify_content: JustifyContent::FlexStart,
padding: Rect::from_points(15.0, 15.0, 15.0, 15.0),
..Style::DEFAULT
},
);
assets.styles.add(
"title",
Style {
font_size: 20.0,
size: Size {
width: Dimension::Auto,
height: Points(10.0),
},
..Style::DEFAULT
},
);
assets.styles.add(
"paragraph",
Style {
size: Size {
width: Dimension::Auto,
height: Points(15.0),
},
..Style::DEFAULT
},
);
assets.styles.add(
"blockquote",
Style {
background_color: Some("#eeeeee"),
size: Size {
width: Dimension::Auto,
height: Points(23.0),
},
..Style::DEFAULT
},
);
assets.styles.add(
"blockquote-text",
Style {
flex_grow: 1.0,
margin: Rect::from_points(5.0, 5.0, 5.0, 5.0),
size: Size {
width: Dimension::Auto,
height: Points(20.0),
},
..Style::DEFAULT
},
);
// Define fonts
assets.fonts.add(
// You can use this font by setting the `font-family` property to a style
// The name of `default` means the default font if `font-family` is not specified
"default",
include_bytes!("assets/fonts/Roboto-Regular.ttf").as_slice(),
);
// Pass a XML string to `dom::parse`.
let root = dom::parse(r#"
Lorem Ipsum
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras sollicitudin mollis ipsum, eu aliquam est consequat vitae.
Donec nunc erat, porttitor eu massa blandit, pulvinar aliquam turpis. Maecenas augue justo, auctor ornare eleifend sed, suscipit ut mauris.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras sollicitudin mollis ipsum, eu aliquam est consequat vitae.
Mauris in mattis lectus. Nulla eget iaculis ligula, eu pulvinar leo.
vitae laoreet erat mauris sed ipsum.
"#).unwrap();
// Build `PdfDocumentReference` (this struct is in printpdf) by passing a XML and assets.
let doc = Document::new(&root, assets)
.unwrap()
.build()
.unwrap();
// Call the `save` to export a PDF.
let buf = &mut BufWriter::new(File::create("dist/simple.pdf").unwrap());
doc.save(buf).unwrap();
}
```
The code above will make a PDF like below.
|Result|
| ---- |
|
|
## Try with examples
You can try this library by running example codes included in the repository.
```sh
# Clone this repository.
$ git clone [email protected]:ktmouk/markup-pdf-rs.git
$ cd markup-pdf-rs
# Download some fonts from Google Fonts and put them on the `examples/assets/fonts/` dir.
$ ./examples/assets/fonts/install.sh
# Try some example codes that make a PDF file.
# PDF files will be made in the `dist/` dir.
$ cargo run --example recipe
$ cargo run --example resume
```
## Examples
|Simple|Nikujaga Recipe (JP)|Japanese Resume (JP)|
| ---- | ---- | ---- |
| | 
| 
|
|[Code](examples/simple.rs)|[Code](examples/recipe.rs)|[Code](examples/resume.rs)|
## Elements
|Name|Usage|
| ---- | ---- |
|``|XML must start with this element. It can have only `` elements as children.|
|``|This element means one page of PDF. It should have a fixed size defined in the style to determined the page size. It can have `` and `` elements as children.|
|``|This element is like `
` of HTML. You can use it for setting the styles. It can have `` and `` elements as children.|
|``|You can use this element to write texts. It can have only string as a child. :warning: Currently, this element doesn't support calculating the width and height basing on the text automatically, so you need to specify the width and height by hand.|
## Styles
Styles are basically the same as [taffy](https://github.com/DioxusLabs/taffy) apart from some of property for specifying colors.
You can check the [style.rs](src/style.rs).