Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ad-si/invoice-maker
Generate beautiful invoices from simple Typst or YAML data records
https://github.com/ad-si/invoice-maker
cli generator invoice latex markdown package pandoc template typescript typst yaml
Last synced: 23 days ago
JSON representation
Generate beautiful invoices from simple Typst or YAML data records
- Host: GitHub
- URL: https://github.com/ad-si/invoice-maker
- Owner: ad-si
- License: isc
- Created: 2016-04-11T16:36:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-09T14:10:57.000Z (5 months ago)
- Last Synced: 2024-09-29T05:04:04.188Z (about 1 month ago)
- Topics: cli, generator, invoice, latex, markdown, package, pandoc, template, typescript, typst, yaml
- Language: Typst
- Homepage: https://typst.app/universe/package/invoice-maker
- Size: 3.25 MB
- Stars: 119
- Watchers: 3
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
# Invoice Maker
Generate beautiful invoices from a simple data record.
## Features
- **Simple, yet Powerful**
- Write invoices as simple `.typ` or `.yaml` files
- No need to install anything but [Typst]
- Support for cancellations, discounts, and taxes
- **Multilingual**
- Integrated support for English and German
- Easy to add more languages by adding a translation dictionary
(Check out this example:
[custom-language.typ](./examples/custom-language.typ))
- **Customizable**
- User your own banner image
- Customize the colors and fonts
- **Elegant**
- Modern design with a focus on readability
- PDFs with a professional look
- **Stable**
- Visual regression tests to ensure consistent output
- **Free and Open Source**
- ISC License
[Typst]: https://typst.app
## Installation & Usage
1. Download the [invoice-maker.typ](./invoice-maker.typ) file
1. Create a new `invoice.typ` file.
E.g. based on one of the examples below:
- [English example](./examples/en.typ)
- [German example](./examples/de.typ)
- [YAML example](./examples/load-yaml.typ)
1. Run typst to generate the invoice:
```sh
typst compile invoice.typ
```
1. Use the generated `invoice.pdf` file 🎉
## Development
Run Tests:
```sh
make test
```
## Legacy Version
Invoice Maker was originally implemented with TypeScript and Pandoc
as seen in [`./typescript_pandoc`](./typescript_pandoc).
This version is still in maintenance mode, but will not receive new features.