Skip to content

Commit

Permalink
docs: update links
Browse files Browse the repository at this point in the history
  • Loading branch information
schoero committed Nov 1, 2023
1 parent 9c17aef commit 9f6b66a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ With SwissQRBill you can easily generate the new QR Code payment slips in Node.j
* [Installation](#installation)
* [Importing the library](#importing-the-library)
* [Quick start](#quick-start)
* [API documentation](https://github.com/schoero/SwissQRBill/blob/master/docs)
* [API documentation](./docs)
* [PDFKit documentation](http://pdfkit.org/docs/getting_started.html)
* [how to create a complete qr bill](https://github.com/schoero/SwissQRBill/blob/master/docs/how-to-create-a-complete-qr-bill.md)
* [how to create a complete qr bill](./docs/how-to-create-a-complete-qr-bill.md)
* [QR bill validator](https://swiss-qr-invoice.org/validator/?lang=de)
* [QR bill specifications](https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-en.pdf)

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SwissQRBill

The documentation for SwissQRBill is located in [github.com/schoero/swissqrbill/docs](https://github.com/schoero/SwissQRBill/tree/v4/docs).
The documentation for SwissQRBill is located in [github.com/schoero/swissqrbill/docs](https://github.com/schoero/swissqrbill/tree/main/docs).

## Getting started

Expand Down
8 changes: 4 additions & 4 deletions docs/how-to-create-a-complete-qr-bill.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ In addition, [PDFKit][npm pdfkit] is required to create the PDF file itself. Ins
npm i pdfkit
```

After the installation, PDFKit and SwissQRBill are available to be imported to the project. Take a look at the [importing guide of SwissQRBill](https://github.com/schoero/SwissQRBill/blob/v4/docs/importing.md#importing-the-library), to learn how to import the library for the different environments.
After the installation, PDFKit and SwissQRBill are available to be imported to the project. Take a look at the [importing guide of SwissQRBill](./importing.md#importing-the-library), to learn how to import the library for the different environments.

```ts
import PDFDocument from "pdfkit";
Expand Down Expand Up @@ -136,7 +136,7 @@ pdf.path(logoText)
.fill();
```

Because the coordinate system of a PDF is based on points, SwissQRBill provides a utility function called [`mm2pt()`](https://github.com/schoero/SwissQRBill/blob/v4/docs/utils/utils.md#mm2ptmillimeters) to convert millimeters to points. Import it like this:
Because the coordinate system of a PDF is based on points, SwissQRBill provides a utility function called [`mm2pt()`](./utils/utils.md#mm2ptmillimeters) to convert millimeters to points. Import it like this:

```ts
import { mm2pt } from "swissqrbill/utils";
Expand Down Expand Up @@ -398,8 +398,8 @@ When you run the code above, SwissQRBill should generate a PDF file named `qr-bi

![Complete QR bill](../assets/complete-qr-bill.png)

[swissqrbill]: https://github.com/schoero/SwissQRBill/blob/v4/docs/pdf/index.md#swissqrbill
[table]: https://github.com/schoero/SwissQRBill/blob/v4/docs/pdf/index.md#table
[swissqrbill]: ./pdf/index.md#swissqrbill
[table]: ./pdf/index.md#table
[pdfdocument]: http://pdfkit.org/docs/getting_started.html#creating_a_document
[source code]: ../examples/how-to-create-a-complete-qr-bill/src/index.js
[stackblitz]: https://stackblitz.com/fork/github/schoero/swissqrbill/tree/v4/examples/how-to-create-a-complete-qr-bill?file=src%2Findex.js&title=How%20to%20create%20a%20complete%20bill&startScript=generate
Expand Down

0 comments on commit 9f6b66a

Please sign in to comment.