summaryrefslogtreecommitdiffstats
path: root/node_modules/boxen/readme.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-18 23:26:45 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-18 23:26:45 +0100
commit81ddf9b700bc48a1f8e472209f080f9c1d9a9b09 (patch)
tree8b959d50c5a614cbf9fcb346ed556140374d4b6d /node_modules/boxen/readme.md
parent1870f3fdf43707a15fda0f609a021f516f45eb63 (diff)
downloadwebsite_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.tar.gz
website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.tar.bz2
website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.zip
rm node_modules
Diffstat (limited to 'node_modules/boxen/readme.md')
-rw-r--r--node_modules/boxen/readme.md175
1 files changed, 0 insertions, 175 deletions
diff --git a/node_modules/boxen/readme.md b/node_modules/boxen/readme.md
deleted file mode 100644
index d8db8e9..0000000
--- a/node_modules/boxen/readme.md
+++ /dev/null
@@ -1,175 +0,0 @@
-# <img src="screenshot.png" width="400" alt="boxen">
-
-> Create boxes in the terminal
-
-[![Build Status](https://travis-ci.org/sindresorhus/boxen.svg?branch=master)](https://travis-ci.org/sindresorhus/boxen)
-
-
-## Install
-
-```
-$ npm install boxen
-```
-
-
-## Usage
-
-```js
-const boxen = require('boxen');
-
-console.log(boxen('unicorn', {padding: 1}));
-/*
-┌─────────────┐
-│ │
-│ unicorn │
-│ │
-└─────────────┘
-*/
-
-console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));
-/*
-
- ╔═════════════╗
- ║ ║
- ║ unicorn ║
- ║ ║
- ╚═════════════╝
-
-*/
-```
-
-
-## API
-
-### boxen(input, [options])
-
-#### input
-
-Type: `string`
-
-Text inside the box.
-
-#### options
-
-##### borderColor
-
-Type: `string`<br>
-Values: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white` `gray`
-
-Color of the box border.
-
-##### borderStyle
-
-Type: `string` `object`<br>
-Default: `single`<br>
-Values:
-- `single`
-```
-┌───┐
-│foo│
-└───┘
-```
-- `double`
-```
-╔═══╗
-║foo║
-╚═══╝
-```
-- `round` (`single` sides with round corners)
-```
-╭───╮
-│foo│
-╰───╯
-```
-- `single-double` (`single` on top and bottom, `double` on right and left)
-```
-╓───╖
-║foo║
-╙───╜
-```
-- `double-single` (`double` on top and bottom, `single` on right and left)
-```
-╒═══╕
-│foo│
-╘═══╛
-```
-- `classic`
-```
-+---+
-|foo|
-+---+
-```
-
-Style of the box border.
-
-Can be any of the above predefined styles or an object with the following keys:
-
-```js
-{
- topLeft: '+',
- topRight: '+',
- bottomLeft: '+',
- bottomRight: '+',
- horizontal: '-',
- vertical: '|'
-}
-```
-
-##### dimBorder
-
-Type: `boolean`<br>
-Default: `false`
-
-Reduce opacity of the border.
-
-##### padding
-
-Type: `number` `Object`<br>
-Default: `0`
-
-Space between the text and box border.
-
-Accepts a number or an object with any of the `top`, `right`, `bottom`, `left` properties. When a number is specified, the left/right padding is 3 times the top/bottom to make it look nice.
-
-##### margin
-
-Type: `number` `Object`<br>
-Default: `0`
-
-Space around the box.
-
-Accepts a number or an object with any of the `top`, `right`, `bottom`, `left` properties. When a number is specified, the left/right margin is 3 times the top/bottom to make it look nice.
-
-##### float
-
-Type: `string`<br>
-Values: `right` `center` `left`<br>
-Default: `left`
-
-Float the box on the available terminal screen space.
-
-##### backgroundColor
-
-Type: `string`<br>
-Values: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white`
-
-Color of the background.
-
-##### align
-
-Type: `string`<br>
-Default: `left`<br>
-Values: `left` `center` `right`
-
-Align the text in the box based on the widest line.
-
-
-## Related
-
-- [boxen-cli](https://github.com/sindresorhus/boxen-cli) - CLI for this module
-- [cli-boxes](https://github.com/sindresorhus/cli-boxes) - Boxes for use in the terminal
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)