Update docs.

See #505 and #1494
This commit is contained in:
Glavin Wiechert 2017-04-15 02:27:12 -03:00
parent 85a744fb98
commit 66830b53fc
2 changed files with 79 additions and 25 deletions

View File

@ -84,6 +84,7 @@ Some of the supported beautifiers are developed for Node.js and are automaticall
| Latex Beautify | :x: | Go to https://github.com/cmhughes/latexindent.pl and follow the instructions. |
| Lua beautifier | :x: | Go to https://www.perl.org/ and follow the instructions. |
| Marko Beautifier | :white_check_mark: | Nothing! |
| Nginx Beautify | :white_check_mark: | Nothing! |
| ocp-indent | :x: | Go to https://www.typerex.org/ocp-indent.html and follow the instructions. |
| Perltidy | :x: | Go to http://perltidy.sourceforge.net/ and follow the instructions. |
| PHP-CS-Fixer | :x: | Go to https://github.com/FriendsOfPHP/PHP-CS-Fixer and follow the instructions. |
@ -145,8 +146,8 @@ See [all supported options in the documentation at `docs/options.md`](docs/opti
| Lua | `Lua` |`.lua` | [`Lua beautifier`](https://www.perl.org/) (Default) |
| Markdown | `GitHub Markdown` |`.markdown`, `.md` | [`Remark`](https://github.com/wooorm/remark), [`Tidy Markdown`](https://github.com/slang800/tidy-markdown) (Default) |
| Marko | `Marko` |`.marko` | [`Marko Beautifier`](https://github.com/marko-js/marko-prettyprint) (Default) |
| Nginx | `nginx` |`.conf` | [`Nginx Beautify`](https://github.com/denysvitali/nginxbeautify) (Default) |
| Mustache | `HTML (Mustache)` |`.mustache` | [`JS Beautify`](https://github.com/beautify-web/js-beautify) (Default), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) |
| Nginx | `nginx` |`.conf` | [`Nginx Beautify`](https://github.com/denysvitali/nginxbeautify) (Default) |
| Nunjucks | `Nunjucks`, `Nunjucks Templates`, `HTML (Nunjucks Templates)` |`.njk`, `.nunjucks` | [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
| Objective-C | `Objective-C`, `Objective-C++` |`.m`, `.mm`, `.h` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default), [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) |
| OCaml | `OCaml` |`.ml` | [`ocp-indent`](https://www.typerex.org/ocp-indent.html) (Default) |

View File

@ -8725,8 +8725,9 @@ Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `dontJoinCurlyBracet` | :white_check_mark: |
| `spaces` | :white_check_mark: |
| `tabs` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
**Description**:
@ -8813,52 +8814,78 @@ undefined (Supported by Nginx Beautify)
}
```
##### [Spaces](#spaces)
##### [Indent char](#indent-char)
**Namespace**: `nginx`
**Key**: `spaces`
**Key**: `indent_char`
**Type**: `number`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indent with spaces (Supported by Nginx Beautify)
Indentation character (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"spaces": 0
"indent_char": " "
}
}
```
##### [Tabs](#tabs)
##### [Indent size](#indent-size)
**Namespace**: `nginx`
**Key**: `tabs`
**Key**: `indent_size`
**Default**: `1`
**Default**: `4`
**Type**: `number`
**Type**: `integer`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indent with tabs (Supported by Nginx Beautify)
Indentation size/length (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"tabs": 1
"indent_size": 4
}
}
```
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `nginx`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"indent_with_tabs": false
}
}
```
@ -16677,52 +16704,78 @@ List of tags (defaults to [head,body,/html] that should have an extra newline be
### Nginx Beautify
##### [Spaces](#spaces)
##### [Indent size](#indent-size)
**Namespace**: `nginx`
**Key**: `spaces`
**Key**: `indent_size`
**Type**: `number`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indent with spaces (Supported by Nginx Beautify)
Indentation size/length (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"spaces": 0
"indent_size": 4
}
}
```
##### [Tabs](#tabs)
##### [Indent char](#indent-char)
**Namespace**: `nginx`
**Key**: `tabs`
**Key**: `indent_char`
**Default**: `1`
**Default**: ` `
**Type**: `number`
**Type**: `string`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indent with tabs (Supported by Nginx Beautify)
Indentation character (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"tabs": 1
"indent_char": " "
}
}
```
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `nginx`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"indent_with_tabs": false
}
}
```