Improve and update docs
This commit is contained in:
parent
4e113794ef
commit
f7ddbf1085
|
@ -42,6 +42,13 @@ apm install atom-beautify
|
|||
|
||||
Or Settings/Preferences ➔ Packages ➔ Search for `atom-beautify`
|
||||
|
||||
### Important Notice: Analytics
|
||||
|
||||
By default `Anonymous Analytics` is enabled.
|
||||
If you do not wish to have usage data sent to Google Analytics then please disable `Anonymous Analytics` option before using Atom-Beautify.
|
||||
See [`Anonymous Analytics` section of docs](https://github.com/Glavin001/atom-beautify/blob/master/docs/options.md#anonymous-analytics) for details.
|
||||
Thank you.
|
||||
|
||||
## Language Support
|
||||
|
||||
See [all supported options in the documentation at `docs/options.md`](https://github.com/Glavin001/atom-beautify/blob/master/docs/options.md).
|
||||
|
|
|
@ -46,7 +46,7 @@ Or Settings/Preferences ➔ Packages ➔ Search for `atom-beautify`
|
|||
|
||||
By default `Anonymous Analytics` is enabled.
|
||||
If you do not wish to have usage data sent to Google Analytics then please disable `Anonymous Analytics` option before using Atom-Beautify.
|
||||
See https://github.com/Glavin001/atom-beautify/blob/master/docs/options.md#anonymous-analytics for details.
|
||||
See [`Anonymous Analytics` section of docs](https://github.com/Glavin001/atom-beautify/blob/master/docs/options.md#anonymous-analytics) for details.
|
||||
Thank you.
|
||||
|
||||
## Language Support
|
||||
|
@ -70,7 +70,7 @@ See [all supported options in the documentation at `docs/options.md`](https://g
|
|||
| Elm | `Elm` |`.elm` | [`elm-format`](https://github.com/avh4/elm-format) (Default) |
|
||||
| ERB | `HTML (Ruby - ERB)`, `HTML (Rails)` |`.erb` | [`HTML Beautifier`](https://github.com/threedaymonk/htmlbeautifier), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
|
||||
| Erlang | `Erlang` |`.erl` | [`erl_tidy`](http://erlang.org/doc/man/erl_tidy.html) (Default) |
|
||||
| Fortran | `Fortran - Modern` |`.f90` | [`Fortran Beautifier`](https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/fortran-beautifier/emacs-fortran-formating-script.lisp) (Default) |
|
||||
| Fortran | `Fortran - Modern` |`.f90`, `.F90` | [`Fortran Beautifier`](https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/fortran-beautifier/emacs-fortran-formating-script.lisp) (Default) |
|
||||
| gherkin | `Gherkin` |`.feature` | [`Gherkin formatter`](https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/gherkin.coffee) (Default) |
|
||||
| Go | `Go` |`.go` | [`gofmt`](https://golang.org/cmd/gofmt/) (Default) |
|
||||
| Handlebars | `Handlebars`, `HTML (Handlebars)` |`.hbs`, `.handlebars` | [`JS Beautify`](https://github.com/beautify-web/js-beautify) (Default), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) |
|
||||
|
@ -109,7 +109,7 @@ See [all supported options in the documentation at `docs/options.md`](https://g
|
|||
| Vala | `Vala` |`.vala`, `.vapi` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default) |
|
||||
| Visualforce | `Visualforce` |`.page` | [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
|
||||
| Vue | `Vue Component` |`.vue` | `Vue Beautifier` (Default) |
|
||||
| XML | `SLD`, `XML`, `XHTML`, `XSD`, `XSL`, `JSP` |`.sld`, `.xml`, `.xhtml`, `.xsd`, `.xsl`, `.jsp` | [`JS Beautify`](https://github.com/beautify-web/js-beautify), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
|
||||
| XML | `SLD`, `XML`, `XHTML`, `XSD`, `XSL`, `JSP`, `GSP` |`.sld`, `.xml`, `.xhtml`, `.xsd`, `.xsl`, `.jsp`, `.gsp` | [`JS Beautify`](https://github.com/beautify-web/js-beautify), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
|
||||
| XTemplate | `XTemplate` |`.xtemplate` | [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
|
||||
|
||||
## Usage
|
||||
|
|
1466
docs/options.md
1466
docs/options.md
File diff suppressed because it is too large
Load Diff
|
@ -261,7 +261,9 @@
|
|||
"typescript formatter",
|
||||
"yapf",
|
||||
"erl_tidy",
|
||||
"marko beautifier"
|
||||
"marko beautifier",
|
||||
"vue",
|
||||
"vue beautifier"
|
||||
],
|
||||
"devDependencies": {
|
||||
"coffeelint": "^1.10.1",
|
||||
|
|
|
@ -10,9 +10,10 @@ module.exports = {
|
|||
title: 'Anonymous Analytics'
|
||||
type : 'boolean'
|
||||
default : true
|
||||
description : "There is [Segment.io](https://segment.io/) which forwards data to [Google
|
||||
Analytics](http://www.google.com/analytics/) to track what languages are being
|
||||
used the most, as well as other stats. Everything is anonymized and no personal
|
||||
description : "[Google
|
||||
Analytics](http://www.google.com/analytics/) is used to track what languages are being
|
||||
used the most and causing the most errors, as well as other stats such as performance.
|
||||
Everything is anonymized and no personal
|
||||
information, such as source code, is sent.
|
||||
See https://github.com/Glavin001/atom-beautify/issues/47 for more details."
|
||||
_analyticsUserId :
|
||||
|
|
Loading…
Reference in New Issue