Create gh-pages branch via GitHub

annexare · Apr 17, 2016 · 4d80236 · 4d80236
commit 4d80236
Show file tree

Hide file tree

Showing 5 changed files with 885 additions and 0 deletions.
diff --git a/index.html b/index.html
@@ -0,0 +1,86 @@
+<!DOCTYPE html>
+<html lang="en-us">
+  <head>
+    <meta charset="UTF-8">
+    <title>Packdir by annexare</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
+    <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
+    <link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
+  </head>
+  <body>
+    <section class="page-header">
+      <h1 class="project-name">Packdir</h1>
+      <h2 class="project-tagline">Pack specified directory with native OS command line tools.</h2>
+      <a href="https://github.com/annexare/PackDir" class="btn">View on GitHub</a>
+      <a href="https://github.com/annexare/PackDir/zipball/master" class="btn">Download .zip</a>
+      <a href="https://github.com/annexare/PackDir/tarball/master" class="btn">Download .tar.gz</a>
+    </section>
+
+    <section class="main-content">
+      <h1>
+<a id="packdir" class="anchor" href="#packdir" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>PackDir</h1>
+
+<p>Pack specified directory with native current OS command line tools.</p>
+
+<p>Main purpose was to pack the OS X/Windows Electron app,
+so Linux was not tested yet.
+<br>
+By default, if specified <code>path</code> has a <code>darwin</code> in it's name,
+the directory will be packed as DMG under OS X.</p>
+
+<h2>
+<a id="usage" class="anchor" href="#usage" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage</h2>
+
+<p>Get the package via NPM: <code>npm install pack-dir</code>.</p>
+
+<div class="highlight highlight-source-js"><pre><span class="pl-k">const</span> <span class="pl-c1">Pack</span> <span class="pl-k">=</span> <span class="pl-c1">require</span>(<span class="pl-s"><span class="pl-pds">'</span>pack-dir<span class="pl-pds">'</span></span>);
+
+<span class="pl-k">let</span> dir <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">'</span>some/test/dir<span class="pl-pds">'</span></span>;
+
+<span class="pl-c">// Set custom DMG RegEx, default is `/darwin/`.</span>
+<span class="pl-smi">Pack</span>.<span class="pl-en">param</span>(<span class="pl-s"><span class="pl-pds">'</span>dmg<span class="pl-pds">'</span></span>,<span class="pl-sr"> <span class="pl-pds">/</span>osx<span class="pl-pds">/</span></span>);
+
+<span class="pl-c">// Pack the directory</span>
+<span class="pl-smi">Pack</span>.<span class="pl-en">path</span>(dir);</pre></div>
+
+<h3>
+<a id="parameters" class="anchor" href="#parameters" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameters</h3>
+
+<ul>
+<li>
+<code>dmg</code> <code>boolean|RegEx</code>, check to pack into DMG instead of ZIP.</li>
+<li>
+<code>dmgFormat</code> <code>string</code>, the <code>hdiutil -format</code> parameter value (<a href="https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/hdiutil.1.html">docs</a>).</li>
+<li>
+<code>isSilent</code> <code>boolean</code>, <code>false</code>, will write only Errors to console.</li>
+<li>
+<code>isSync</code> <code>boolean</code>, <code>true</code>, synchronous packaging.</li>
+</ul>
+
+<h2>
+<a id="credits" class="anchor" href="#credits" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Credits</h2>
+
+<p>Created by <a href="https://annexare.com/">Annexare Studio</a>.
+Feel free to use it as you need in your apps or send updates into <a href="https://github.com/annexare/PackDir">this</a> public repository.
+All code is under MIT license.</p>
+
+<h2>
+<a id="7-zip" class="anchor" href="#7-zip" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>7-Zip</h2>
+
+<p>For Windows host <a href="http://www.7-zip.org/">7-Zip</a> standalone console app is used
+(~1MB, doesn't require installation).
+All license files are included with it, with respect to the author (Igor Pavlov).</p>
+
+      <footer class="site-footer">
+        <span class="site-footer-owner"><a href="https://github.com/annexare/PackDir">Packdir</a> is maintained by <a href="https://github.com/annexare">annexare</a>.</span>
+
+        <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span>
+      </footer>
+
+    </section>
+
+
+  </body>
+</html>
diff --git a/params.json b/params.json
@@ -0,0 +1,6 @@
+{
+  "name": "Packdir",
+  "tagline": "Pack specified directory with native OS command line tools.",
+  "body": "# PackDir\r\n\r\nPack specified directory with native current OS command line tools.\r\n\r\nMain purpose was to pack the OS X/Windows Electron app,\r\nso Linux was not tested yet.\r\n<br>\r\nBy default, if specified `path` has a `darwin` in it's name,\r\nthe directory will be packed as DMG under OS X.\r\n\r\n## Usage\r\n\r\nGet the package via NPM: `npm install pack-dir`.\r\n\r\n```js\r\nconst Pack = require('pack-dir');\r\n\r\nlet dir = 'some/test/dir';\r\n\r\n// Set custom DMG RegEx, default is `/darwin/`.\r\nPack.param('dmg', /osx/);\r\n\r\n// Pack the directory\r\nPack.path(dir);\r\n```\r\n\r\n### Parameters\r\n\r\n* `dmg` `boolean|RegEx`, check to pack into DMG instead of ZIP.\r\n* `dmgFormat` `string`, the `hdiutil -format` parameter value ([docs](https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/hdiutil.1.html)).\r\n* `isSilent` `boolean`, `false`, will write only Errors to console.\r\n* `isSync` `boolean`, `true`, synchronous packaging.\r\n\r\n## Credits\r\n\r\nCreated by [Annexare Studio](https://annexare.com/).\r\nFeel free to use it as you need in your apps or send updates into [this](https://github.com/annexare/PackDir) public repository.\r\nAll code is under MIT license.\r\n\r\n## 7-Zip\r\n\r\nFor Windows host [7-Zip](http://www.7-zip.org/) standalone console app is used\r\n(~1MB, doesn't require installation).\r\nAll license files are included with it, with respect to the author (Igor Pavlov).\r\n",
+  "note": "Don't delete this file! It's used internally to help with page regeneration."
+}
diff --git a/stylesheets/github-light.css b/stylesheets/github-light.css
@@ -0,0 +1,124 @@
+/*
+The MIT License (MIT)
+
+Copyright (c) 2015 GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+*/
+
+.pl-c /* comment */ {
+  color: #969896;
+}
+
+.pl-c1      /* constant, markup.raw, meta.diff.header, meta.module-reference, meta.property-name, support, support.constant, support.variable, variable.other.constant */,
+.pl-s .pl-v /* string variable */ {
+  color: #0086b3;
+}
+
+.pl-e  /* entity */,
+.pl-en /* entity.name */ {
+  color: #795da3;
+}
+
+.pl-s .pl-s1 /* string source */,
+.pl-smi      /* storage.modifier.import, storage.modifier.package, storage.type.java, variable.other, variable.parameter.function */ {
+  color: #333;
+}
+
+.pl-ent /* entity.name.tag */ {
+  color: #63a35c;
+}
+
+.pl-k /* keyword, storage, storage.type */ {
+  color: #a71d5d;
+}
+
+.pl-pds              /* punctuation.definition.string, string.regexp.character-class */,
+.pl-s                /* string */,
+.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
+.pl-sr               /* string.regexp */,
+.pl-sr .pl-cce       /* string.regexp constant.character.escape */,
+.pl-sr .pl-sra       /* string.regexp string.regexp.arbitrary-repitition */,
+.pl-sr .pl-sre       /* string.regexp source.ruby.embedded */ {
+  color: #183691;
+}
+
+.pl-v /* variable */ {
+  color: #ed6a43;
+}
+
+.pl-id /* invalid.deprecated */ {
+  color: #b52a1d;
+}
+
+.pl-ii /* invalid.illegal */ {
+  background-color: #b52a1d;
+  color: #f8f8f8;
+}
+
+.pl-sr .pl-cce /* string.regexp constant.character.escape */ {
+  color: #63a35c;
+  font-weight: bold;
+}
+
+.pl-ml /* markup.list */ {
+  color: #693a17;
+}
+
+.pl-mh        /* markup.heading */,
+.pl-mh .pl-en /* markup.heading entity.name */,
+.pl-ms        /* meta.separator */ {
+  color: #1d3e81;
+  font-weight: bold;
+}
+
+.pl-mq /* markup.quote */ {
+  color: #008080;
+}
+
+.pl-mi /* markup.italic */ {
+  color: #333;
+  font-style: italic;
+}
+
+.pl-mb /* markup.bold */ {
+  color: #333;
+  font-weight: bold;
+}
+
+.pl-md /* markup.deleted, meta.diff.header.from-file */ {
+  background-color: #ffecec;
+  color: #bd2c00;
+}
+
+.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
+  background-color: #eaffea;
+  color: #55a532;
+}
+
+.pl-mdr /* meta.diff.range */ {
+  color: #795da3;
+  font-weight: bold;
+}
+
+.pl-mo /* meta.output */ {
+  color: #1d3e81;
+}
+