This repository has been archived by the owner on Mar 7, 2018. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 30ed7d0
Showing
9 changed files
with
643 additions
and
0 deletions.
There are no files selected for viewing
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,148 @@ | ||
<!DOCTYPE html> | ||
<html> | ||
|
||
<head> | ||
<meta charset='utf-8' /> | ||
<meta http-equiv="X-UA-Compatible" content="chrome=1" /> | ||
<meta name="description" content="sic : Wraps a value in a function." /> | ||
|
||
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css"> | ||
|
||
<title>sic</title> | ||
</head> | ||
|
||
<body> | ||
|
||
<!-- HEADER --> | ||
<div id="header_wrap" class="outer"> | ||
<header class="inner"> | ||
<a id="forkme_banner" href="https://github.com/pluma/sic">View on GitHub</a> | ||
|
||
<h1 id="project_title">sic</h1> | ||
<h2 id="project_tagline">Wraps a value in a function.</h2> | ||
|
||
<section id="downloads"> | ||
<a class="zip_download_link" href="https://github.com/pluma/sic/zipball/master">Download this project as a .zip file</a> | ||
<a class="tar_download_link" href="https://github.com/pluma/sic/tarball/master">Download this project as a tar.gz file</a> | ||
</section> | ||
</header> | ||
</div> | ||
|
||
<!-- MAIN CONTENT --> | ||
<div id="main_content_wrap" class="outer"> | ||
<section id="main_content" class="inner"> | ||
<h1> | ||
<a name="synopsis" class="anchor" href="#synopsis"><span class="octicon octicon-link"></span></a>Synopsis</h1> | ||
|
||
<p><strong>sic</strong> is a JavaScript function for wrapping a value in a function.</p> | ||
|
||
<p><a href="https://ci.testling.com/pluma/sic"><img src="https://ci.testling.com/pluma/sic.png" alt="browser support"></a></p> | ||
|
||
<p><a href="https://travis-ci.org/pluma/sic"><img src="https://travis-ci.org/pluma/sic.png?branch=master" alt="Build Status"></a> <a href="http://badge.fury.io/js/sic"><img src="https://badge.fury.io/js/sic.png" alt="NPM version"></a> <a href="https://david-dm.org/pluma/sic"><img src="https://david-dm.org/pluma/sic.png" alt="Dependencies"></a></p> | ||
|
||
<h1> | ||
<a name="why" class="anchor" href="#why"><span class="octicon octicon-link"></span></a>Why?</h1> | ||
|
||
<p>It's trivial to implement, but in order to keep code DRY (and avoid silly mistakes) it makes sense to define this function only once per project. This library is the logical consequence of that.</p> | ||
|
||
<h1> | ||
<a name="install" class="anchor" href="#install"><span class="octicon octicon-link"></span></a>Install</h1> | ||
|
||
<h2> | ||
<a name="nodejs" class="anchor" href="#nodejs"><span class="octicon octicon-link"></span></a>Node.js</h2> | ||
|
||
<h3> | ||
<a name="with-npm" class="anchor" href="#with-npm"><span class="octicon octicon-link"></span></a>With NPM</h3> | ||
|
||
<div class="highlight highlight-sh"><pre>npm install sic | ||
</pre></div> | ||
|
||
<h3> | ||
<a name="from-source" class="anchor" href="#from-source"><span class="octicon octicon-link"></span></a>From source</h3> | ||
|
||
<div class="highlight highlight-sh"><pre>git clone https://github.com/pluma/sic.git | ||
<span class="nb">cd </span>sic | ||
npm install | ||
make | ||
</pre></div> | ||
|
||
<h2> | ||
<a name="browser" class="anchor" href="#browser"><span class="octicon octicon-link"></span></a>Browser</h2> | ||
|
||
<h3> | ||
<a name="with-component" class="anchor" href="#with-component"><span class="octicon octicon-link"></span></a>With component</h3> | ||
|
||
<div class="highlight highlight-sh"><pre>component install pluma/sic | ||
</pre></div> | ||
|
||
<p><a href="https://github.com/component/component">Learn more about component</a>.</p> | ||
|
||
<h3> | ||
<a name="with-bower" class="anchor" href="#with-bower"><span class="octicon octicon-link"></span></a>With bower</h3> | ||
|
||
<div class="highlight highlight-sh"><pre>bower install sic | ||
</pre></div> | ||
|
||
<p><a href="https://github.com/twitter/bower">Learn more about bower</a>.</p> | ||
|
||
<h3> | ||
<a name="with-a-commonjs-module-loader" class="anchor" href="#with-a-commonjs-module-loader"><span class="octicon octicon-link"></span></a>With a CommonJS module loader</h3> | ||
|
||
<p>Download the <a href="https://raw.github.com/pluma/sic/master/dist/sic.min.js">latest minified CommonJS release</a> and add it to your project.</p> | ||
|
||
<p><a href="http://wiki.commonjs.org/wiki/Modules/1.1">Learn more about CommonJS modules</a>.</p> | ||
|
||
<h3> | ||
<a name="with-an-amd-module-loader" class="anchor" href="#with-an-amd-module-loader"><span class="octicon octicon-link"></span></a>With an AMD module loader</h3> | ||
|
||
<p>Download the <a href="https://raw.github.com/pluma/sic/master/dist/sic.amd.min.js">latest minified AMD release</a> and add it to your project.</p> | ||
|
||
<p><a href="http://requirejs.org/docs/whyamd.html">Learn more about AMD modules</a>.</p> | ||
|
||
<h3> | ||
<a name="as-a-standalone-library" class="anchor" href="#as-a-standalone-library"><span class="octicon octicon-link"></span></a>As a standalone library</h3> | ||
|
||
<p>Download the <a href="https://raw.github.com/pluma/sic/master/dist/sic.globals.min.js">latest minified standalone release</a> and add it to your project.</p> | ||
|
||
<div class="highlight highlight-html"><pre><span class="nt"><script </span><span class="na">src=</span><span class="s">"/your/js/path/sic.globals.min.js"</span><span class="nt">></script></span> | ||
</pre></div> | ||
|
||
<p>This makes the <code>sic</code> function available in the global namespace.</p> | ||
|
||
<h1> | ||
<a name="basic-usage-example" class="anchor" href="#basic-usage-example"><span class="octicon octicon-link"></span></a>Basic usage example</h1> | ||
|
||
<div class="highlight highlight-javascript"><pre><span class="kd">var</span> <span class="nx">sic</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'sic'</span><span class="p">);</span> | ||
|
||
<span class="kd">var</span> <span class="nx">fn</span> <span class="o">=</span> <span class="nx">sic</span><span class="p">(</span><span class="s1">'hello'</span><span class="p">);</span> | ||
|
||
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">fn</span><span class="p">());</span> <span class="c1">// 'hello'</span> | ||
</pre></div> | ||
|
||
<h1> | ||
<a name="api" class="anchor" href="#api"><span class="octicon octicon-link"></span></a>API</h1> | ||
|
||
<h2> | ||
<a name="sicvaluefunction" class="anchor" href="#sicvaluefunction"><span class="octicon octicon-link"></span></a>sic(value):Function</h2> | ||
|
||
<p>Wraps the given value in a function.</p> | ||
|
||
<h1> | ||
<a name="license" class="anchor" href="#license"><span class="octicon octicon-link"></span></a>License</h1> | ||
|
||
<p>The code is released into the Public Domain according to the terms of <a href="http://creativecommons.org/publicdomain/zero/1.0/">CC0</a>.</p> | ||
</section> | ||
</div> | ||
|
||
<!-- FOOTER --> | ||
<div id="footer_wrap" class="outer"> | ||
<footer class="inner"> | ||
<p class="copyright">sic maintained by <a href="https://github.com/pluma">pluma</a></p> | ||
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p> | ||
</footer> | ||
</div> | ||
|
||
|
||
|
||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
console.log('This would be the main JS file.'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"name":"sic","tagline":"Wraps a value in a function.","body":"# Synopsis\r\n\r\n**sic** is a JavaScript function for wrapping a value in a function.\r\n\r\n[![browser support](https://ci.testling.com/pluma/sic.png)](https://ci.testling.com/pluma/sic)\r\n\r\n[![Build Status](https://travis-ci.org/pluma/sic.png?branch=master)](https://travis-ci.org/pluma/sic) [![NPM version](https://badge.fury.io/js/sic.png)](http://badge.fury.io/js/sic) [![Dependencies](https://david-dm.org/pluma/sic.png)](https://david-dm.org/pluma/sic)\r\n\r\n# Why?\r\n\r\nIt's trivial to implement, but in order to keep code DRY (and avoid silly mistakes) it makes sense to define this function only once per project. This library is the logical consequence of that.\r\n\r\n# Install\r\n\r\n## Node.js\r\n\r\n### With NPM\r\n\r\n```sh\r\nnpm install sic\r\n```\r\n\r\n### From source\r\n\r\n```sh\r\ngit clone https://github.com/pluma/sic.git\r\ncd sic\r\nnpm install\r\nmake\r\n```\r\n\r\n## Browser\r\n\r\n### With component\r\n\r\n```sh\r\ncomponent install pluma/sic\r\n```\r\n\r\n[Learn more about component](https://github.com/component/component).\r\n\r\n### With bower\r\n\r\n```sh\r\nbower install sic\r\n```\r\n\r\n[Learn more about bower](https://github.com/twitter/bower).\r\n\r\n### With a CommonJS module loader\r\n\r\nDownload the [latest minified CommonJS release](https://raw.github.com/pluma/sic/master/dist/sic.min.js) and add it to your project.\r\n\r\n[Learn more about CommonJS modules](http://wiki.commonjs.org/wiki/Modules/1.1).\r\n\r\n### With an AMD module loader\r\n\r\nDownload the [latest minified AMD release](https://raw.github.com/pluma/sic/master/dist/sic.amd.min.js) and add it to your project.\r\n\r\n[Learn more about AMD modules](http://requirejs.org/docs/whyamd.html).\r\n\r\n### As a standalone library\r\n\r\nDownload the [latest minified standalone release](https://raw.github.com/pluma/sic/master/dist/sic.globals.min.js) and add it to your project.\r\n\r\n```html\r\n<script src=\"/your/js/path/sic.globals.min.js\"></script>\r\n```\r\n\r\nThis makes the `sic` function available in the global namespace.\r\n\r\n# Basic usage example\r\n\r\n```javascript\r\nvar sic = require('sic');\r\n\r\nvar fn = sic('hello');\r\n\r\nconsole.log(fn()); // 'hello'\r\n```\r\n\r\n# API\r\n\r\n## sic(value):Function\r\n\r\nWraps the given value in a function.\r\n\r\n# License\r\n\r\nThe code is released into the Public Domain according to the terms of [CC0](http://creativecommons.org/publicdomain/zero/1.0/).","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
.highlight .hll { background-color: #ffffcc } | ||
.highlight { background: #f0f3f3; } | ||
.highlight .c { color: #0099FF; font-style: italic } /* Comment */ | ||
.highlight .err { color: #AA0000; background-color: #FFAAAA } /* Error */ | ||
.highlight .k { color: #006699; font-weight: bold } /* Keyword */ | ||
.highlight .o { color: #555555 } /* Operator */ | ||
.highlight .cm { color: #0099FF; font-style: italic } /* Comment.Multiline */ | ||
.highlight .cp { color: #009999 } /* Comment.Preproc */ | ||
.highlight .c1 { color: #0099FF; font-style: italic } /* Comment.Single */ | ||
.highlight .cs { color: #0099FF; font-weight: bold; font-style: italic } /* Comment.Special */ | ||
.highlight .gd { background-color: #FFCCCC; border: 1px solid #CC0000 } /* Generic.Deleted */ | ||
.highlight .ge { font-style: italic } /* Generic.Emph */ | ||
.highlight .gr { color: #FF0000 } /* Generic.Error */ | ||
.highlight .gh { color: #003300; font-weight: bold } /* Generic.Heading */ | ||
.highlight .gi { background-color: #CCFFCC; border: 1px solid #00CC00 } /* Generic.Inserted */ | ||
.highlight .go { color: #AAAAAA } /* Generic.Output */ | ||
.highlight .gp { color: #000099; font-weight: bold } /* Generic.Prompt */ | ||
.highlight .gs { font-weight: bold } /* Generic.Strong */ | ||
.highlight .gu { color: #003300; font-weight: bold } /* Generic.Subheading */ | ||
.highlight .gt { color: #99CC66 } /* Generic.Traceback */ | ||
.highlight .kc { color: #006699; font-weight: bold } /* Keyword.Constant */ | ||
.highlight .kd { color: #006699; font-weight: bold } /* Keyword.Declaration */ | ||
.highlight .kn { color: #006699; font-weight: bold } /* Keyword.Namespace */ | ||
.highlight .kp { color: #006699 } /* Keyword.Pseudo */ | ||
.highlight .kr { color: #006699; font-weight: bold } /* Keyword.Reserved */ | ||
.highlight .kt { color: #007788; font-weight: bold } /* Keyword.Type */ | ||
.highlight .m { color: #FF6600 } /* Literal.Number */ | ||
.highlight .s { color: #CC3300 } /* Literal.String */ | ||
.highlight .na { color: #330099 } /* Name.Attribute */ | ||
.highlight .nb { color: #336666 } /* Name.Builtin */ | ||
.highlight .nc { color: #00AA88; font-weight: bold } /* Name.Class */ | ||
.highlight .no { color: #336600 } /* Name.Constant */ | ||
.highlight .nd { color: #9999FF } /* Name.Decorator */ | ||
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */ | ||
.highlight .ne { color: #CC0000; font-weight: bold } /* Name.Exception */ | ||
.highlight .nf { color: #CC00FF } /* Name.Function */ | ||
.highlight .nl { color: #9999FF } /* Name.Label */ | ||
.highlight .nn { color: #00CCFF; font-weight: bold } /* Name.Namespace */ | ||
.highlight .nt { color: #330099; font-weight: bold } /* Name.Tag */ | ||
.highlight .nv { color: #003333 } /* Name.Variable */ | ||
.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */ | ||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */ | ||
.highlight .mf { color: #FF6600 } /* Literal.Number.Float */ | ||
.highlight .mh { color: #FF6600 } /* Literal.Number.Hex */ | ||
.highlight .mi { color: #FF6600 } /* Literal.Number.Integer */ | ||
.highlight .mo { color: #FF6600 } /* Literal.Number.Oct */ | ||
.highlight .sb { color: #CC3300 } /* Literal.String.Backtick */ | ||
.highlight .sc { color: #CC3300 } /* Literal.String.Char */ | ||
.highlight .sd { color: #CC3300; font-style: italic } /* Literal.String.Doc */ | ||
.highlight .s2 { color: #CC3300 } /* Literal.String.Double */ | ||
.highlight .se { color: #CC3300; font-weight: bold } /* Literal.String.Escape */ | ||
.highlight .sh { color: #CC3300 } /* Literal.String.Heredoc */ | ||
.highlight .si { color: #AA0000 } /* Literal.String.Interpol */ | ||
.highlight .sx { color: #CC3300 } /* Literal.String.Other */ | ||
.highlight .sr { color: #33AAAA } /* Literal.String.Regex */ | ||
.highlight .s1 { color: #CC3300 } /* Literal.String.Single */ | ||
.highlight .ss { color: #FFCC33 } /* Literal.String.Symbol */ | ||
.highlight .bp { color: #336666 } /* Name.Builtin.Pseudo */ | ||
.highlight .vc { color: #003333 } /* Name.Variable.Class */ | ||
.highlight .vg { color: #003333 } /* Name.Variable.Global */ | ||
.highlight .vi { color: #003333 } /* Name.Variable.Instance */ | ||
.highlight .il { color: #FF6600 } /* Literal.Number.Integer.Long */ | ||
|
||
.type-csharp .highlight .k { color: #0000FF } | ||
.type-csharp .highlight .kt { color: #0000FF } | ||
.type-csharp .highlight .nf { color: #000000; font-weight: normal } | ||
.type-csharp .highlight .nc { color: #2B91AF } | ||
.type-csharp .highlight .nn { color: #000000 } | ||
.type-csharp .highlight .s { color: #A31515 } | ||
.type-csharp .highlight .sc { color: #A31515 } |
Oops, something went wrong.