This repository has been archived by the owner on Jul 16, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
c04b9c8
commit 608e845
Showing
27 changed files
with
6,093 additions
and
8 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
remote_theme: mikearnaldi/just-the-docs | ||
|
||
# Enable or disable the site search | ||
search_enabled: true | ||
|
||
# Aux links for the upper right navigation | ||
aux_links: | ||
'@effect/printer-ansi on GitHub': | ||
- 'https://github.com/Effect-TS/printer' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
title: Home | ||
nav_order: 1 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: AnsiDoc.ts | ||
nav_order: 1 | ||
parent: Modules | ||
--- | ||
|
||
## AnsiDoc overview | ||
|
||
Added in v1.0.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [model](#model) | ||
- [AnsiDoc (type alias)](#ansidoc-type-alias) | ||
|
||
--- | ||
|
||
# model | ||
|
||
## AnsiDoc (type alias) | ||
|
||
**Signature** | ||
|
||
```ts | ||
export type AnsiDoc = Doc<AnsiStyle> | ||
``` | ||
Added in v1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
--- | ||
title: AnsiRender.ts | ||
nav_order: 2 | ||
parent: Modules | ||
--- | ||
|
||
## AnsiRender overview | ||
|
||
Added in v1.0.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [rendering algorithms](#rendering-algorithms) | ||
- [compact](#compact) | ||
- [pretty](#pretty) | ||
- [prettyDefault](#prettydefault) | ||
- [prettyUnbounded](#prettyunbounded) | ||
- [render](#render) | ||
- [smart](#smart) | ||
- [smartDefault](#smartdefault) | ||
- [smartUnbounded](#smartunbounded) | ||
|
||
--- | ||
|
||
# rendering algorithms | ||
|
||
## compact | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const compact: (self: AnsiDoc) => string | ||
``` | ||
Added in v1.0.0 | ||
## pretty | ||
**Signature** | ||
```ts | ||
export declare const pretty: { | ||
(options: Partial<Omit<AvailablePerLine, '_tag'>>): (self: Doc<AnsiStyle>) => string | ||
(self: Doc<AnsiStyle>, options: Partial<Omit<AvailablePerLine, '_tag'>>): string | ||
} | ||
``` | ||
Added in v1.0.0 | ||
## prettyDefault | ||
**Signature** | ||
```ts | ||
export declare const prettyDefault: (self: AnsiDoc) => string | ||
``` | ||
Added in v1.0.0 | ||
## prettyUnbounded | ||
**Signature** | ||
```ts | ||
export declare const prettyUnbounded: (self: AnsiDoc) => string | ||
``` | ||
Added in v1.0.0 | ||
## render | ||
**Signature** | ||
```ts | ||
export declare const render: (self: DocStream<AnsiStyle>) => string | ||
``` | ||
Added in v1.0.0 | ||
## smart | ||
**Signature** | ||
```ts | ||
export declare const smart: { | ||
(options: Partial<Omit<AvailablePerLine, '_tag'>>): (self: Doc<AnsiStyle>) => string | ||
(self: Doc<AnsiStyle>, options: Partial<Omit<AvailablePerLine, '_tag'>>): string | ||
} | ||
``` | ||
Added in v1.0.0 | ||
## smartDefault | ||
**Signature** | ||
```ts | ||
export declare const smartDefault: (self: AnsiDoc) => string | ||
``` | ||
Added in v1.0.0 | ||
## smartUnbounded | ||
**Signature** | ||
```ts | ||
export declare const smartUnbounded: (self: Doc<AnsiStyle>) => string | ||
``` | ||
Added in v1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,169 @@ | ||
--- | ||
title: AnsiStyle.ts | ||
nav_order: 3 | ||
parent: Modules | ||
--- | ||
|
||
## AnsiStyle overview | ||
|
||
Added in v1.0.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [constructors](#constructors) | ||
- [backgroundColor](#backgroundcolor) | ||
- [bold](#bold) | ||
- [color](#color) | ||
- [dullBackgroundColor](#dullbackgroundcolor) | ||
- [dullColor](#dullcolor) | ||
- [italicized](#italicized) | ||
- [underlined](#underlined) | ||
- [destructors](#destructors) | ||
- [stringify](#stringify) | ||
- [instances](#instances) | ||
- [Monoid](#monoid) | ||
- [Semigroup](#semigroup) | ||
- [model](#model) | ||
- [AnsiStyle (interface)](#ansistyle-interface) | ||
- [utils](#utils) | ||
- [combine](#combine) | ||
|
||
--- | ||
|
||
# constructors | ||
|
||
## backgroundColor | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const backgroundColor: (color: Color) => AnsiStyle | ||
``` | ||
Added in v1.0.0 | ||
## bold | ||
**Signature** | ||
```ts | ||
export declare const bold: AnsiStyle | ||
``` | ||
Added in v1.0.0 | ||
## color | ||
**Signature** | ||
```ts | ||
export declare const color: (color: Color) => AnsiStyle | ||
``` | ||
Added in v1.0.0 | ||
## dullBackgroundColor | ||
**Signature** | ||
```ts | ||
export declare const dullBackgroundColor: (color: Color) => AnsiStyle | ||
``` | ||
Added in v1.0.0 | ||
## dullColor | ||
**Signature** | ||
```ts | ||
export declare const dullColor: (color: Color) => AnsiStyle | ||
``` | ||
Added in v1.0.0 | ||
## italicized | ||
**Signature** | ||
```ts | ||
export declare const italicized: AnsiStyle | ||
``` | ||
Added in v1.0.0 | ||
## underlined | ||
**Signature** | ||
```ts | ||
export declare const underlined: AnsiStyle | ||
``` | ||
Added in v1.0.0 | ||
# destructors | ||
## stringify | ||
**Signature** | ||
```ts | ||
export declare const stringify: (self: AnsiStyle) => string | ||
``` | ||
Added in v1.0.0 | ||
# instances | ||
## Monoid | ||
**Signature** | ||
```ts | ||
export declare const Monoid: monoid.Monoid<AnsiStyle> | ||
``` | ||
Added in v1.0.0 | ||
## Semigroup | ||
**Signature** | ||
```ts | ||
export declare const Semigroup: semigroup.Semigroup<AnsiStyle> | ||
``` | ||
Added in v1.0.0 | ||
# model | ||
## AnsiStyle (interface) | ||
**Signature** | ||
```ts | ||
export interface AnsiStyle { | ||
readonly foreground: Option<SGR> | ||
readonly background: Option<SGR> | ||
readonly bold: Option<SGR> | ||
readonly italicized: Option<SGR> | ||
readonly underlined: Option<SGR> | ||
} | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
# utils | ||
|
||
## combine | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const combine: (self: AnsiStyle, that: AnsiStyle) => AnsiStyle | ||
``` | ||
Added in v1.0.0 |
Oops, something went wrong.