Skip to content
This repository has been archived by the owner on Jun 15, 2023. It is now read-only.

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
paulmillr committed Aug 10, 2016
1 parent fe61964 commit c6049d4
Show file tree
Hide file tree
Showing 16 changed files with 103 additions and 103 deletions.
14 changes: 7 additions & 7 deletions app.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/commands.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h2 id="tips">Tips</h2>
alias bbp=&#39;brunch build --production&#39;
alias bw=&#39;brunch watch&#39;
alias bws=&#39;brunch watch --server&#39;
</code></pre><div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"><a href="/docs/config">Config &rarr;</a></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/tree/master/app/assets/_docs/commands.md">Edit commands.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
</code></pre><div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"><a href="/docs/config">Config &rarr;</a></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/blob/master/source/source/app/assets/_docs/commands.md">Edit commands.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
</script> <script type="text/javascript">
var _gauges = _gauges || [];
(function() {
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@
javascripts: {joinTo: {
&#39;app.js&#39;: /^app/, // all code from &#39;app/&#39;,
&#39;vendor.js&#39;: /^(?!app)/ // all BUT app code - &#39;vendor/&#39;, &#39;node_modules/&#39;, etc
},
}},
stylesheets: {joinTo: &#39;app.css&#39;}
}
}
</code></pre>
<p>The Brunch config is <strong>declarative</strong>, not <strong>imperative</strong> — you tell Brunch what you want to get, not how to actually do it.</p>
<div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"><a href="/docs/getting-started">&larr; Getting started</a></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"><a href="/docs/why-brunch">Why Brunch &rarr;</a></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/tree/master/app/assets/_docs/concepts.md">Edit concepts.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
<div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"><a href="/docs/getting-started">&larr; Getting started</a></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"><a href="/docs/why-brunch">Why Brunch &rarr;</a></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/blob/master/source/source/app/assets/_docs/concepts.md">Edit concepts.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
</script> <script type="text/javascript">
var _gauges = _gauges || [];
(function() {
Expand Down
16 changes: 9 additions & 7 deletions docs/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ <h2 id="-files-"><code>files</code></h2>
<li><code>&lt;type&gt;</code>: <code>javascripts</code>, <code>stylesheets</code> or <code>templates</code><ul>
<li>joinTo: (required) describes how files will be compiled &amp; joined together.
Available formats:<ul>
<li>&#39;outputFilePath&#39; in order to have all source files compiled together to one</li>
<li>map of (&#39;outputFilePath&#39;: <a href="https://github.com/es128/anymatch#anymatch-">anymatch set</a>)</li>
<li><code>&#39;outputFilePath&#39;</code> in order to have all source files compiled together to one</li>
<li>map of (<code>&#39;outputFilePath&#39;:</code> <a href="https://github.com/es128/anymatch">anymatch set</a>)</li>
</ul>
</li>
<li>entryPoints: (optional) describes the entry points of an application. The specified file and all of its dependencies will then be joined into a single file. Resembles <code>joinTo</code> but allows to included only the files you need.
Available formats:<ul>
<li><code>&#39;entryFile.js&#39;: &#39;outputFilePath&#39;</code></li>
<li>`&#39;entryFile.js&#39;: map of (&#39;outputFilePath&#39;: anymatch set)</li>
<li><code>&#39;entryFile.js&#39;:</code> map of (<code>&#39;outputFilePath&#39;:</code> <a href="https://github.com/es128/anymatch">anymatch set</a>)</li>
</ul>
</li>
<li>order: (optional) defines compilation order. <code>vendor</code> files will be compiled before other ones even if they are not present here.<ul>
Expand Down Expand Up @@ -120,6 +120,7 @@ <h2 id="-npm-"><code>npm</code></h2>
<li><code>npm.globals</code>: <code>Object</code>: a mapping from global name (as a key) to the corresponding module name (string) to expose.</li>
<li><code>npm.styles</code>: <code>Object</code>: a mapping from package name (string) to an array of stylesheet paths (relative to package root) to be included into the build.</li>
<li><code>npm.static</code>: <code>Array</code>: a list of javascript files from npm packages to be included as-is, without analyzing their dependencies or wrapping them into modules.</li>
<li><code>npm.aliases</code>: <code>Object</code>: a mapping of files from an alias to a real package name. For example, if you are using <code>exoskeleton</code> fork of Backbone, setting this to <code>{&quot;backbone&quot;: &quot;exoskeleton&quot;}</code> would load Exoskeleton when requiring backbone.</li>
</ul>
<p>Example:</p>
<pre><code class="lang-javascript">npm: {
Expand Down Expand Up @@ -154,7 +155,7 @@ <h2 id="-conventions-"><code>conventions</code></h2>
<p>Keep in mind that default brunch regexps, as you see, consider <strong>all</strong> <code>vendor/</code> (etc.) directories as vendor (etc.) files. So, <code>app/views/vendor/thing/chaplin_view.coffee</code> will be treated as vendor file.</p>
<p>Example:</p>
<pre><code class="lang-javascript">conventions: {
ignored: (() =&gt; false), // override defaults for no ignored files
ignored: () =&gt; false, // override defaults for no ignored files
assets: /files[\\/]/ // vendor/jquery/files/jq.img
}
</code></pre>
Expand Down Expand Up @@ -236,14 +237,14 @@ <h2 id="-server-"><code>server</code></h2>
// up to you to respect the `port` argument allowing users to change it from the CLI
const myServer = http.createServer();
myServer.listen(port, callback);
myServer.on(&#39;request&#39;, function(req, res) {/* do stuff */});
myServer.on(&#39;request&#39;, (req, res) =&gt; { /* do stuff */ });
return myServer;
}
</code></pre>
<pre><code class="lang-javascript"> // Example using custom `close` method.
module.exports = (port, path, callback) =&gt; {
// custom server code
return {close: () =&gt; { /* code for shutting down server */ }}
return {close() { /* code for shutting down server */ }}
}
</code></pre>
<ul>
Expand Down Expand Up @@ -275,6 +276,7 @@ <h2 id="-sourcemaps-"><code>sourceMaps</code></h2>
<ul>
<li>set to <code>&#39;old&#39;</code> to use the old <code>@</code> control character instead of <code>#</code>.</li>
<li>set to <code>&#39;absoluteUrl&#39;</code> to set the <code>sourceMappingURL</code> to the complete URL path starting from <code>config.paths.public</code></li>
<li>set to <code>&#39;inline&#39;</code> to set the <code>sourceMappingURL</code> to a data URI containing the source map (no .map file will be written)</li>
</ul>
<h2 id="-filelistinterval-"><code>fileListInterval</code></h2>
<p><code>Integer</code>: Sets an interval in ms which determines how often brunch file list should be
Expand Down Expand Up @@ -354,7 +356,7 @@ <h2 id="tips">Tips</h2>
<li>You can use CoffeeScript to write configuration files. This way they&#39;ll be
much shorter and concise. Simply create a file called <code>brunch-config.coffee</code>.</li>
</ul>
<div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"><a href="/docs/commands">&larr; Commands</a></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"><a href="/docs/plugins">Plugin API &rarr;</a></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/tree/master/app/assets/_docs/config.md">Edit config.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
<div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"><a href="/docs/commands">&larr; Commands</a></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"><a href="/docs/plugins">Plugin API &rarr;</a></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/blob/master/source/source/app/assets/_docs/config.md">Edit config.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
</script> <script type="text/javascript">
var _gauges = _gauges || [];
(function() {
Expand Down
2 changes: 1 addition & 1 deletion docs/deploying.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
dir here.
</li>
</ul>
<div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"><a href="/docs/testing">&larr; Testing</a></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/tree/master/app/assets/_docs/deploying.md">Edit deploying.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
<div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"><a href="/docs/testing">&larr; Testing</a></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/blob/master/source/source/app/assets/_docs/deploying.md">Edit deploying.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
</script> <script type="text/javascript">
var _gauges = _gauges || [];
(function() {
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h2 id="plugging-alternative-tableware">Plugging alternative tableware</h2>
and include <em>compiled</em> content of <code>drink.coffee</code> in the output file. <strong>Voila!</strong></p>
<h2 id="becoming-professional-cook">Becoming professional cook</h2>
<p>Keen to learn the remaining 10%? Check out the <a href="https://github.com/brunch/brunch-guide#readme">advanced guide to Brunch</a>, which also describes using Brunch on a legacy codebase. Happy cooking!</p>
<div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"><a href="/docs/concepts">Core concepts &rarr;</a></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/tree/master/app/assets/_docs/getting-started.md">Edit getting-started.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
<div class="container doc-nav"><div class="grid"><div class="grid__item one-whole lap-and-up-one-half"></div><div style="text-align: right;" class="grid__item one-whole lap-and-up-one-half"><a href="/docs/concepts">Core concepts &rarr;</a></div><div class="grid__item one-whole"><span class="note"><a href="https://github.com/brunch/brunch.github.io/blob/master/source/source/app/assets/_docs/getting-started.md">Edit getting-started.md on GitHub</a></span></div></div></div></div></div><footer><hr class="rule"><p><small>Hosted on <a href="https://github.com/brunch/brunch.github.com">GitHub Pages</a>. The content on this website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">CC BY 3.0</a>. Logo by <a href="http://helle.in">Michael Hellein</a></small></p></footer></div><script src="/app.js"></script><script>require('init');
</script> <script type="text/javascript">
var _gauges = _gauges || [];
(function() {
Expand Down
Loading

0 comments on commit c6049d4

Please sign in to comment.