[docs] Improve doc (#170)

* Improve doc

* Fix

* Fix 2

* Fix 3

* Fix 4

* docs: generate docs

Co-authored-by: Nam Hoang Le <[email protected]>

Author: nam-hle

Diff for: .README/README.md

@@ -1,5 +1,7 @@
 # Table
 
+> Produces a string that represents array data in a text table.
+
 [![Travis build status](http://img.shields.io/travis/gajus/table/master.svg?style=flat-square)](https://travis-ci.org/gajus/table)
 [![Coveralls](https://img.shields.io/coveralls/gajus/table.svg?style=flat-square)](https://coveralls.io/github/gajus/table)
 [![NPM version](http://img.shields.io/npm/v/table.svg?style=flat-square)](https://www.npmjs.org/package/table)
@@ -8,8 +10,6 @@
 
 {"gitdown": "contents"}
 
-Produces a string that represents array data in a text table.
-
 ![Demo of table displaying a list of missions to the Moon.](./.README/demo.png)
 
 ## Features
@@ -22,16 +22,30 @@ Produces a string that represents array data in a text table.
 * Configurable column width.
 * Text wrapping.
 
+## Install
+
+{"gitdown": "include", "file": "./install.md"}
+
+## Usage
+
 {"gitdown": "include", "file": "./usage.md"}
 
-{"gitdown": "include", "file": "./usage/cell_content_alignment.md"}
-{"gitdown": "include", "file": "./usage/column_width.md"}
-{"gitdown": "include", "file": "./usage/custom_border.md"}
-{"gitdown": "include", "file": "./usage/draw_vertical_line.md"}
-{"gitdown": "include", "file": "./usage/draw_horizontal_line.md"}
-{"gitdown": "include", "file": "./usage/single_line_mode.md"}
-{"gitdown": "include", "file": "./usage/padding_cell_content.md"}
-{"gitdown": "include", "file": "./usage/predefined_border_templates.md"}
-{"gitdown": "include", "file": "./usage/streaming.md"}
-{"gitdown": "include", "file": "./usage/text_truncation.md"}
-{"gitdown": "include", "file": "./usage/text_wrapping.md"}
+## API
+
+{"gitdown": "include", "file": "./api/table/index.md"}
+{"gitdown": "include", "file": "./api/table/border.md"}
+{"gitdown": "include", "file": "./api/table/draw_vertical_line.md"}
+{"gitdown": "include", "file": "./api/table/draw_horizontal_line.md"}
+{"gitdown": "include", "file": "./api/table/single_line.md"}
+
+{"gitdown": "include", "file": "./api/table/columns/index.md"}
+{"gitdown": "include", "file": "./api/table/columns/width.md"}
+{"gitdown": "include", "file": "./api/table/columns/alignment.md"}
+{"gitdown": "include", "file": "./api/table/columns/padding.md"}
+{"gitdown": "include", "file": "./api/table/columns/truncate.md"}
+{"gitdown": "include", "file": "./api/table/columns/wrapWord.md"}
+{"gitdown": "include", "file": "./api/table/column_default.md"}
+
+{"gitdown": "include", "file": "./api/stream/index.md"}
+
+{"gitdown": "include", "file": "./api/get_border_characters.md"}

Diff for: .README/usage/predefined_border_templates.md renamed to .README/api/get_border_characters.md

@@ -1,27 +1,26 @@
-### Predefined Border Templates
+### getBorderCharacters
+
+**Parameter:**
+ - **_template_**
+   - Type: `'honeywell' | 'norc' | 'ramac' | 'void'`
+   - Required: `true`
 
 You can load one of the predefined border templates using `getBorderCharacters` function.
 
 ```js
-import {
-  table,
-  getBorderCharacters
-} from 'table';
-
-let config,
-  data;
+import { table, getBorderCharacters } from 'table';
 
-data = [
+const data = [
   ['0A', '0B', '0C'],
   ['1A', '1B', '1C'],
   ['2A', '2B', '2C']
 ];
 
-config = {
+const config = {
   border: getBorderCharacters(`name of the template`)
 };
 
-table(data, config);
+console.log(table(data, config));
 ```
 
 ```
@@ -55,7 +54,7 @@ table(data, config);
 | 2A | 2B | 2C |
 +----+----+----+
 
-# void (no borders; see "bordless table" section of the documentation)
+# void (no borders; see "borderless table" section of the documentation)
 
  0A  0B  0C
 
@@ -69,23 +68,21 @@ Raise [an issue](https://github.com/gajus/table/issues) if you'd like to contrib
 
 #### Borderless Table
 
-Simply using "void" border character template creates a table with a lot of unnecessary spacing.
+Simply using `void` border character template creates a table with a lot of unnecessary spacing.
 
-To create a more plesant to the eye table, reset the padding and remove the joining rows, e.g.
+To create a more pleasant to the eye table, reset the padding and remove the joining rows, e.g.
 
 ```js
-let output;
 
-output = table(data, {
-    border: getBorderCharacters(`void`),
+const output = table(data, {
+    border: getBorderCharacters('void'),
     columnDefault: {
         paddingLeft: 0,
         paddingRight: 1
     },
-    drawHorizontalLine: () => {
-        return false
+    drawHorizontalLine: () => false
     }
-});
+);
 
 console.log(output);
 ```

Diff for: .README/usage/streaming.md renamed to .README/api/stream/index.md

@@ -1,32 +1,29 @@
-### Streaming
+### createStream
 
 `table` package exports `createStream` function used to draw a table and append rows.
 
-`createStream` requires `{number} columnDefault.width` and `{number} columnCount` configuration properties.
+Parameter:
+ - _**config:**_ the same as `table`'s, except `config.columnDefault.width` and `config.columnCount` must be provided.
 
-```js
-import {
-  createStream
-} from 'table';
 
-let config,
-  stream;
+```js
+import { createStream } from 'table';
 
-config = {
+const config = {
   columnDefault: {
     width: 50
   },
   columnCount: 1
 };
 
-stream = createStream(config);
+const stream = createStream(config);
 
 setInterval(() => {
   stream.write([new Date()]);
 }, 500);
 ```
 
-![Streaming current date.](./.README/streaming.gif)
+![Streaming current date.](./.README/api/stream/streaming.gif)
 
 `table` package uses ANSI escape codes to overwrite the output of the last line when a new row is printed.
 
@@ -35,38 +32,29 @@ The underlying implementation is explained in this [Stack Overflow answer](http:
 Streaming supports all of the configuration properties and functionality of a static table (such as auto text wrapping, alignment and padding), e.g.
 
 ```js
-import {
-  createStream
-} from 'table';
+import { createStream } from 'table';
 
 import _ from 'lodash';
 
-let config,
-  stream,
-  i;
-
-config = {
+const config = {
   columnDefault: {
     width: 50
   },
   columnCount: 3,
-  columns: {
-    0: {
+  columns: [
+    {
       width: 10,
       alignment: 'right'
     },
-    1: {
-      alignment: 'center',
-    },
-    2: {
-      width: 10
-    }
-  }
+    { alignment: 'center' },
+    { width: 10 }
+
+  ]
 };
 
-stream = createStream(config);
+const stream = createStream(config);
 
-i = 0;
+let i = 0;
 
 setInterval(() => {
   let random;
@@ -77,4 +65,4 @@ setInterval(() => {
 }, 500);
 ```
 
-![Streaming random data.](./.README/streaming-random.gif)
+![Streaming random data.](./.README/api/stream/streaming-random.gif)

Diff for: .README/streaming-random.gif renamed to .README/api/stream/streaming-random.gif

@@ -1,19 +1,22 @@
-### Custom Border
+##### config.border
 
-`{object} config.border` property describes characters used to draw the table border.
+Type: `{ [type: string]: string }`\
+Default: `honeywell` [template](#getbordercharacters)
 
-```js
-let config,
-  data,
-  output;
+Custom borders. The keys are any of:
+- `topLeft`, `topRight`, `topBody`,`topJoin`
+- `bottomLeft`, `bottomRight`, `bottomBody`, `bottomJoin`
+- `joinLeft`, `joinRight`, `joinBody`, `joinJoin`
+- `bodyLeft`, `bodyRight`, `bodyJoin`
 
-data = [
+```js
+const data = [
   ['0A', '0B', '0C'],
   ['1A', '1B', '1C'],
   ['2A', '2B', '2C']
 ];
 
-config = {
+const config = {
   border: {
     topBody: `─`,
     topJoin: `┬`,
@@ -36,9 +39,7 @@ config = {
   }
 };
 
-output = table(data, config);
-
-console.log(output);
+console.log(table(data, config));
 ```
 
 ```

Diff for: .README/streaming.gif renamed to .README/api/stream/streaming.gif

@@ -0,0 +1,6 @@
+##### config.columnDefault
+
+Type: `Column`\
+Default: `{}`
+
+The default configuration for all columns. Column-specific settings will overwrite the default values.

Diff for: .README/usage/custom_border.md renamed to .README/api/table/border.md

@@ -1,35 +1,30 @@
-### Cell Content Alignment
+###### config.columns[*].alignment
 
-`{string} config.columns[{number}].alignment` property controls content horizontal alignment within a cell.
+Type: `'center' | 'justify' | 'left' | 'right'`\
+Default: `'left'`
 
-Valid values are: "left", "right", "center" and "justify".
+Cell content horizontal alignment
 
 ```js
-let config,
-  data,
-  output;
-
-data = [
+const data = [
   ['0A', '0B', '0C', '0D 0E 0F'],
   ['1A', '1B', '1C', '1D 1E 1F'],
   ['2A', '2B', '2C', '2D 2E 2F'],
 ];
 
-config = {
+const config = {
   columnDefault: {
     width: 10,
   },
   columns: [
-    {alignment: 'left'},
-    {alignment: 'center'},
-    {alignment: 'right'},
-    {alignment: 'justify'},
+    { alignment: 'left' },
+    { alignment: 'center' },
+    { alignment: 'right' },
+    { alignment: 'justify' }
   ],
 };
 
-output = table(data, config);
-
-console.log(output);
+console.log(table(data, config));
 ```
 
 ```

Diff for: .README/api/table/column_default.md

@@ -0,0 +1,4 @@
+##### config.columns
+
+Type: `Column[] | { [columnIndex: number]: Column }`\
+Column specific configurations.

Diff for: .README/usage/cell_content_alignment.md renamed to .README/api/table/columns/alignment.md

@@ -1,33 +1,40 @@
-### Padding Cell Content
+###### config.columns[*].paddingLeft
 
-`{number} config.columns[{number}].paddingLeft` and `{number} config.columns[{number}].paddingRight` properties control content padding within a cell. Property value represents a number of whitespaces used to pad the content.
+Type: `number`\
+Default: `1`
 
-```js
-let config,
-  data,
-  output;
+The number of whitespaces used to pad the content on the left.
+
+###### config.columns[*].paddingRight
+
+Type: `number`\
+Default: `1`
+
+The number of whitespaces used to pad the content on the right.
 
-data = [
+The `paddingLeft` and `paddingRight` options do not count on the column width. So the column has `width = 5`, `paddingLeft = 2` and `paddingRight = 2` will have the total width is `9`.
+
+
+```js
+const data = [
   ['0A', 'AABBCC', '0C'],
   ['1A', '1B', '1C'],
   ['2A', '2B', '2C']
 ];
 
-config = {
-  columns: {
-    0: {
+const config = {
+  columns: [
+    {
       paddingLeft: 3
     },
-    1: {
+    {
       width: 2,
       paddingRight: 3
     }
-  }
+  ]
 };
 
-output = table(data, config);
-
-console.log(output);
+console.log(table(data, config));
 ```
 
 ```