Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added doc/assets/bubble-render.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/bubble-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/google-render.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/google-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/tiger-render.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/tiger-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/transform-render.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/transform-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
120 changes: 118 additions & 2 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,128 @@
height: 6rlh;
margin-left: 1rem;
}

.note {
border-left: 0.25rem solid #0377fc;
padding: 0 1rem;
margin: 1rem 0;
}

.center {
text-align: center;
display: flex;
gap: 1rem;
flex-direction: column;
margin: 0 auto;
}

.medium {
width: 50%;
}

.btn{
background: var(--accent);
color: var(--background-color);
padding: 0.5rem 1rem;
border-radius: 0.25rem;
}

.comparison {
display: flex;
gap: 1rem;
}

.comparison img {
width: 50%;
}

.legend {
font-size: 0.75rem;
color: var(--text-muted);
}

</style>

# Munch the web into crisp documents

**Paper-Muncher** is a next-generation document generation tool tailor-made for business applications.
❓️ **Paper-Muncher** is a next-generation HTML to PDF renderer running on it's own web engine.<br>
Produce beautiful, print-ready documents from web pages fast, without struggle. It's free, open source and available
right now.


<div class="note">
Paper-Muncher is now in alpha. We're currently focused on improving our CSS compliance. While it's
still early days, the project is functional enough to try out, and we're actively looking for feedback. The direction
may still evolve, but you can already get a feel for where we're headed. Let us know what you think in
the <a href="https://github.com/odoo/paper-muncher/issues">GitHub issues</a>!
</div>

## Installation

<div class="center medium">
<a class="btn" href="https://github.com/odoo/paper-muncher/releases/tag/nightly">Download latest Debian release</a>
<a class="btn" href="./install.html">Build From sources</a>
</div>

## Paper Muncher in action

###Bubble sale order
<div class="comparison">
<img src="assets/bubble-source.png" alt="source HTML">
<img src="assets/bubble-render.png" alt="rendered PDF">
</div>


###SVG tiger
<div class="comparison">
<img src="assets/tiger-source.png" alt="source HTML">
<img src="assets/tiger-render.png" alt="rendered PDF">
</div>


###Paginated documents
<div class="comparison">
<img src="assets/tiger-source.png" alt="source HTML">
<img src="assets/tiger-render.png" alt="rendered PDF">
</div>


###Google
<div class="comparison">
<img src="assets/google-source.png" alt="source HTML">
<img src="assets/google-render.png" alt="rendered PDF">
</div>


###Images
<div class="comparison">
<img src="assets/google-source.png" alt="source HTML">
<img src="assets/google-render.png" alt="rendered PDF">
</div>


[//]: # (###Transforms)

[//]: # (<div class="comparison">)

[//]: # ( <img src="assets/transform-source.png" alt="source HTML">)

[//]: # ( <img src="assets/transform-render.png" alt="rendered PDF">)

[//]: # (</div>)


<div class="center medium">
<a class="btn" href="./assets/human-rights.pdf">Download The paginated Universal Declaration of Human Rights</a>
<a class="legend" href="https://www.un.org/en/about-us/universal-declaration-of-human-rights">source</a>
</div>

## Usage

```bash
paper-muncher <input.html> <output.pdf> [options]
```

---

Paper-Muncher is now in early alpha. We're currently focused on improving stability and ensuring compliance. While it's still early days, the project is functional enough to try out, and we're actively looking for feedback. The direction may still evolve, but you can already get a feel for where we're headed. Let us know what you think in the [GitHub issues](https://github.com/odoo/paper-muncher/issues)!

4 changes: 4 additions & 0 deletions doc/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ nav a {
nav a:first-child {
margin-inline-start: 0;
}

body {
--accent: #0078d4;
}
Loading