Add nginx to docs

This commit is contained in:
Denys Vitali 2017-01-30 15:46:48 +01:00
parent 0dd50d6bc6
commit ed45ccec87
1 changed files with 227 additions and 0 deletions

View File

@ -8511,6 +8511,154 @@ Maximum characters per line (0 disables) (Supported by JS Beautify)
} }
``` ```
#### [Nginx](#nginx)
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
| Option | Nginx Beautify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `dontJoinCurlyBracet` | :white_check_mark: |
| `spaces` | :white_check_mark: |
| `tabs` | :white_check_mark: |
**Description**:
Options for language Nginx
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Nginx Beautification
**How to Configure**
1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*.
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
##### [Default Beautifier](#default-beautifier)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Default**: `Nginx Beautify`
**Type**: `string`
**Enum**: `Nginx Beautify`
**Description**:
Default Beautifier to be used for Nginx
**How to Configure**
1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*.
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
##### [Beautify On Save](#beautify-on-save)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Automatically beautify Nginx files on save
**How to Configure**
1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*.
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
##### [Don't join curly brackets](#don't-join-curly-brackets)
**Namespace**: `nginx`
**Key**: `dontJoinCurlyBracet`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
undefined (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"dontJoinCurlyBracet": true
}
}
```
##### [Spaces](#spaces)
**Namespace**: `nginx`
**Key**: `spaces`
**Type**: `number`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indent with spaces (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"spaces": 0
}
}
```
##### [Tabs](#tabs)
**Namespace**: `nginx`
**Key**: `tabs`
**Default**: `1`
**Type**: `number`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indent with tabs (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"tabs": 1
}
}
```
#### [Nunjucks](#nunjucks) #### [Nunjucks](#nunjucks)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
@ -16297,6 +16445,85 @@ List of tags (defaults to [head,body,/html] that should have an extra newline be
``` ```
### Nginx Beautify
##### [Spaces](#spaces)
**Namespace**: `nginx`
**Key**: `spaces`
**Type**: `number`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indent with spaces (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"spaces": 0
}
}
```
##### [Tabs](#tabs)
**Namespace**: `nginx`
**Key**: `tabs`
**Default**: `1`
**Type**: `number`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
Indent with tabs (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"tabs": 1
}
}
```
##### [Don't join curly brackets](#don't-join-curly-brackets)
**Namespace**: `nginx`
**Key**: `dontJoinCurlyBracet`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify)
**Description**:
undefined (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"dontJoinCurlyBracet": true
}
}
```
### PHP-CS-Fixer ### PHP-CS-Fixer
##### [PHP-CS-Fixer Path](#php-cs-fixer-path) ##### [PHP-CS-Fixer Path](#php-cs-fixer-path)