Mirrors
/
atom-beautify
mirror of https://github.com/Glavin001/atom-beautify.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
atom-beautify/docs/code/file/src/config.coffee.html

169 lines
4.6 KiB
HTML
Raw Normal View History

See #596. Add source code documentation to docs/code/
2016-03-03 17:24:13 -07:00
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../../javascript/application.js'></script>
<script src='../../javascript/search.js'></script>
<link rel='stylesheet' href='../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>src</span>
&raquo;
<span class='title'>config.coffee</span>
</div>
</div>
<div id='content'>
<h1>
File:
config.coffee
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='module.exports-variable'>
module.exports
=
</dt>
<dd>
<pre><code class='coffeescript'>{
Update documentation
2016-07-04 20:58:48 -06:00
general: {
title: &#39;General&#39;,
type: &#39;object&#39;,
collapsed: true,
order: -1,
description: &#39;General options for Atom Beautify&#39;,
properties: {
analytics: {
title: &#39;Anonymous Analytics&#39;,
type: &#39;boolean&#39;,
&quot;default&quot;: true,
description: &quot;There is [Segment.io](https:&#47;&#47;segment.io&#47;) which forwards data to [Google Analytics](http:&#47;&#47;www.google.com&#47;analytics&#47;) to track what languages are being used the most, as well as other stats. Everything is anonymized and no personal information, such as source code, is sent. See https:&#47;&#47;github.com&#47;Glavin001&#47;atom-beautify&#47;issues&#47;47 for more details.&quot;
},
_analyticsUserId: {
title: &#39;Analytics User Id&#39;,
type: &#39;string&#39;,
&quot;default&quot;: &quot;&quot;,
description: &quot;Unique identifier for this user for tracking usage analytics&quot;
},
loggerLevel: {
title: &quot;Logger Level&quot;,
type: &#39;string&#39;,
&quot;default&quot;: &#39;warn&#39;,
description: &#39;Set the level for the logger&#39;,
&quot;enum&quot;: [&#39;verbose&#39;, &#39;debug&#39;, &#39;info&#39;, &#39;warn&#39;, &#39;error&#39;]
},
beautifyEntireFileOnSave: {
title: &quot;Beautify Entire File On Save&quot;,
type: &#39;boolean&#39;,
&quot;default&quot;: true,
description: &quot;When beautifying on save, use the entire file, even if there is selected text in the editor. Important: The `beautify on save` option for the specific language must be enabled for this to be applicable. This option is not `beautify on save`.&quot;
},
muteUnsupportedLanguageErrors: {
title: &quot;Mute Unsupported Language Errors&quot;,
type: &#39;boolean&#39;,
&quot;default&quot;: false,
description: &quot;Do not show \&quot;Unsupported Language\&quot; errors when they occur&quot;
},
muteAllErrors: {
title: &quot;Mute All Errors&quot;,
type: &#39;boolean&#39;,
&quot;default&quot;: false,
description: &quot;Do not show any&#47;all errors when they occur&quot;
}
}
See #596. Add source code documentation to docs/code/
2016-03-03 17:24:13 -07:00
}
}</code></pre>
</dd>
</dl>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
Update documentation
2016-07-04 20:58:48 -06:00
2.1.1
See #596. Add source code documentation to docs/code/
2016-03-03 17:24:13 -07:00
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>