Skip to content

Commit

Permalink
docs: regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
schoero committed Nov 11, 2023
1 parent 06816ab commit 89d8301
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 36 deletions.
20 changes: 9 additions & 11 deletions docs/bundle/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Index

<br/>

- Namespaces

- [pdf](#namespace-pdf)
Expand Down Expand Up @@ -164,7 +162,7 @@ const stream = createWriteStream("qr-bill.pdf");
qrBill.attachTo(pdf);
pdf.pipe(stream);
pdf.end();
```
```

<br/>

Expand Down Expand Up @@ -512,7 +510,7 @@ const stream = createWriteStream("table.pdf");
table.attachTo(pdf);
pdf.pipe(stream);
pdf.end();
```
```

<br/>

Expand Down Expand Up @@ -603,7 +601,7 @@ const data = {

const svg = new SwissQRBill(data);
writeFileSync("qr-bill.svg", svg.toString());
```
```

<br/>

Expand Down Expand Up @@ -808,13 +806,13 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L139C0)

*Example:*

```ts
```ts
// Register the font
pdf.registerFont("Liberation-Sans", "path/to/LiberationSans-Regular.ttf");
pdf.registerFont("Liberation-Sans-Bold", "path/to/LiberationSans-Bold.ttf");

const qrBill = new SwissQRBill(data, { fontName: "Liberation-Sans" });
```
```

- **types.language** `"DE"` | `"EN"` | `"FR"` | `"IT"` The language with which the bill is rendered. `optional`
- **types.outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
- **types.scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
Expand All @@ -831,13 +829,13 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L150C0)

*Example:*

```ts
```ts
// Register the font
pdf.registerFont("Liberation-Sans", "path/to/LiberationSans-Regular.ttf");
pdf.registerFont("Liberation-Sans-Bold", "path/to/LiberationSans-Bold.ttf");

const qrBill = new SwissQRBill(data, { fontName: "Liberation-Sans" });
```
```

- **types.language** `"DE"` | `"EN"` | `"FR"` | `"IT"` The language with which the bill is rendered. `optional`
- **types.outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
- **types.scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
Expand Down
6 changes: 2 additions & 4 deletions docs/pdf/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Index

<br/>

- Classes

- [SwissQRBill](#class-swissqrbill)
Expand Down Expand Up @@ -81,7 +79,7 @@ const stream = createWriteStream("qr-bill.pdf");
qrBill.attachTo(pdf);
pdf.pipe(stream);
pdf.end();
```
```

<br/>

Expand Down Expand Up @@ -282,7 +280,7 @@ const stream = createWriteStream("table.pdf");
table.attachTo(pdf);
pdf.pipe(stream);
pdf.end();
```
```

<br/>

Expand Down
14 changes: 6 additions & 8 deletions docs/pdf/types.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Types

<br/>

- Type aliases

- [Language](#type-alias-language)
Expand Down Expand Up @@ -111,13 +109,13 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L139C0)

*Example:*

```ts
```ts
// Register the font
pdf.registerFont("Liberation-Sans", "path/to/LiberationSans-Regular.ttf");
pdf.registerFont("Liberation-Sans-Bold", "path/to/LiberationSans-Bold.ttf");

const qrBill = new SwissQRBill(data, { fontName: "Liberation-Sans" });
```
```

- **language** `"DE"` | `"EN"` | `"FR"` | `"IT"` The language with which the bill is rendered. `optional`
- **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
- **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
Expand All @@ -134,13 +132,13 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L150C0)

*Example:*

```ts
```ts
// Register the font
pdf.registerFont("Liberation-Sans", "path/to/LiberationSans-Regular.ttf");
pdf.registerFont("Liberation-Sans-Bold", "path/to/LiberationSans-Bold.ttf");

const qrBill = new SwissQRBill(data, { fontName: "Liberation-Sans" });
```
```

- **language** `"DE"` | `"EN"` | `"FR"` | `"IT"` The language with which the bill is rendered. `optional`
- **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
- **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
4 changes: 1 addition & 3 deletions docs/svg/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Index

<br/>

- Classes

- [SwissQRBill](#class-swissqrbill)
Expand Down Expand Up @@ -67,7 +65,7 @@ const data = {

const svg = new SwissQRBill(data);
writeFileSync("qr-bill.svg", svg.toString());
```
```

<br/>

Expand Down
14 changes: 6 additions & 8 deletions docs/svg/types.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Types

<br/>

- Type aliases

- [Language](#type-alias-language)
Expand Down Expand Up @@ -111,13 +109,13 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L139C0)

*Example:*

```ts
```ts
// Register the font
pdf.registerFont("Liberation-Sans", "path/to/LiberationSans-Regular.ttf");
pdf.registerFont("Liberation-Sans-Bold", "path/to/LiberationSans-Bold.ttf");

const qrBill = new SwissQRBill(data, { fontName: "Liberation-Sans" });
```
```

- **language** `"DE"` | `"EN"` | `"FR"` | `"IT"` The language with which the bill is rendered. `optional`
- **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
- **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
Expand All @@ -134,13 +132,13 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L150C0)

*Example:*

```ts
```ts
// Register the font
pdf.registerFont("Liberation-Sans", "path/to/LiberationSans-Regular.ttf");
pdf.registerFont("Liberation-Sans-Bold", "path/to/LiberationSans-Bold.ttf");

const qrBill = new SwissQRBill(data, { fontName: "Liberation-Sans" });
```
```

- **language** `"DE"` | `"EN"` | `"FR"` | `"IT"` The language with which the bill is rendered. `optional`
- **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
- **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
2 changes: 0 additions & 2 deletions docs/utils/utils.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Utils

<br/>

- Functions

- [isQRIBAN(iban)](#function-isqribaniban)
Expand Down

0 comments on commit 89d8301

Please sign in to comment.