Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent a962348 commit b77b804
Show file tree
Hide file tree
Showing 6 changed files with 229 additions and 13 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Expand Up @@ -3,3 +3,7 @@
*~
*.log
node_modules
*.env
.DS_Store
package-lock.json
.bloggify/*
13 changes: 13 additions & 0 deletions DOCUMENTATION.md
Expand Up @@ -10,6 +10,7 @@ In particular, the '&','<', and '>' characters are escaped. This should
be run prior to `ansiToHtml`.

#### Params

- **String** `txt`: The input text (containing the ANSI snippets).

#### Return
Expand All @@ -24,6 +25,7 @@ surrounding it. Also, you should apply this after you have run
`ansiToHtml` on the text.

#### Params

- **String** `txt`: The input text.

#### Return
Expand All @@ -47,6 +49,7 @@ CSS. The class names used are of the format `ansi-*-fg/bg` and
i.e black/red/green/yellow/blue/magenta/cyan/white.

#### Params

- **String** `txt`: The input text.
- **Object** `options`: The options passed to the ansiToHTML method.

Expand All @@ -57,6 +60,7 @@ i.e black/red/green/yellow/blue/magenta/cyan/white.
Converts ANSI input into JSON output.

#### Params

- **String** `txt`: The input text.
- **Object** `options`: The options passed to the ansiToHTML method.

Expand All @@ -67,6 +71,7 @@ Converts ANSI input into JSON output.
Converts ANSI input into text output.

#### Params

- **String** `txt`: The input text.

#### Return
Expand All @@ -85,6 +90,7 @@ Sets up the palette.
Escapes the input text.

#### Params

- **String** `txt`: The input text.

#### Return
Expand All @@ -94,6 +100,7 @@ Escapes the input text.
Adds HTML link elements.

#### Params

- **String** `txt`: The input text.

#### Return
Expand All @@ -103,6 +110,7 @@ Adds HTML link elements.
Converts ANSI input into HTML output.

#### Params

- **String** `txt`: The input text.
- **Object** `options`: The options passed ot the `process` method.

Expand All @@ -113,6 +121,7 @@ Converts ANSI input into HTML output.
Converts ANSI input into HTML output.

#### Params

- **String** `txt`: The input text.
- **Object** `options`: The options passed ot the `process` method.

Expand All @@ -123,6 +132,7 @@ Converts ANSI input into HTML output.
Converts ANSI input into HTML output.

#### Params

- **String** `txt`: The input text.

#### Return
Expand All @@ -132,6 +142,7 @@ Converts ANSI input into HTML output.
Processes the input.

#### Params

- **String** `txt`: The input text.
- **Object** `options`: An object passed to `processChunk` method, extended with:
- `json` (Boolean): If `true`, the result will be an object.
Expand All @@ -142,6 +153,7 @@ Processes the input.
Processes the current chunk into json output.

#### Params

- **String** `text`: The input text.
- **Object** `options`: An object containing the following fields:
- `json` (Boolean): If `true`, the result will be an object.
Expand All @@ -163,6 +175,7 @@ Processes the current chunk into json output.
Processes the current chunk of text.

#### Params

- **String** `text`: The input text.
- **Object** `options`: An object containing the following fields:
- `json` (Boolean): If `true`, the result will be an object.
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2012-19 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Copyright (c) 2012-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down

0 comments on commit b77b804

Please sign in to comment.