ppl 4.0.2 → 4.0.3

data/gh-pages/documentation/configuration/color/index.md

@@ -0,0 +1,47 @@
+---
+title: ppl [color] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color
+---
+
+By default, ppl's commands output plain text with no [ANSI color escape
+codes](http://en.wikipedia.org/wiki/ANSI_escape_code). This is good in terms of
+ppl being a well-behaved, pipeable UNIX CLI program, but some people like a bit
+more color in their life, and this section of the config file allows those
+people to selectively enable color output on a per-command basis.
+
+### Enable color for all commands that support it
+
+    [color]
+            age   = true
+            bday  = true
+            email = true
+            ls    = true
+            name  = true
+            nick  = true
+            org   = true
+            phone = true
+            post  = true
+            show  = true
+            url   = true
+
+### List of supported colors
+
+* black
+* blue
+* cyan
+* green
+* magenta
+* red
+* white
+* yellow
+
+### Unsupported commands
+
+The [mutt](/documentation/commands/mutt) command doesn't support color output
+and never will. It'd be completely pointless.
+
+The [show](/documentation/commands/show) command doesn't, either, but this is
+due to be added sometime soon.
+

data/gh-pages/documentation/configuration/color_age/index.md

@@ -0,0 +1,20 @@
+---
+title: ppl [color "age"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "age"
+---
+
+This section dictates the color of the output of the
+[age](/documentation/commands/age) command.
+
+### Example
+
+    [color "age"]
+        id  = green
+        age = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_bday/index.md

@@ -0,0 +1,20 @@
+---
+title: ppl [color "bday"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "bday"
+---
+
+This section dictates the color of the output of the
+[bday](/documentation/commands/bday) command.
+
+### Example
+
+    [color "bday"]
+        id       = green
+        birthday = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_email/index.md

@@ -0,0 +1,21 @@
+---
+title: ppl [color "email"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "email"
+---
+
+This section dictates the color of the output of the
+[email](/documentation/commands/email) command.
+
+### Example
+
+    [color "email"]
+        star            = red
+        id              = green
+        email_addresses = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_ls/index.md

@@ -0,0 +1,21 @@
+---
+title: ppl [color "ls"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "ls"
+---
+
+This section dictates the color of the output of the
+[ls](/documentation/commands/ls) command.
+
+### Example
+
+    [color "ls"]
+        id    = green
+        name  = yellow
+        email = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_name/index.md

@@ -0,0 +1,20 @@
+---
+title: ppl [color "name"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "name"
+---
+
+This section dictates the color of the output of the
+[name](/documentation/commands/name) command.
+
+### Example
+
+    [color "name"]
+        id   = green
+        name = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_nick/index.md

@@ -0,0 +1,20 @@
+---
+title: ppl [color "nick"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "nick"
+---
+
+This section dictates the color of the output of the
+[nick](/documentation/commands/nick) command.
+
+### Example
+
+    [color "nick"]
+        id        = green
+        nicknames = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_org/index.md

@@ -0,0 +1,20 @@
+---
+title: ppl [color "org"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "org"
+---
+
+This section dictates the color of the output of the
+[org](/documentation/commands/org) command.
+
+### Example
+
+    [color "org"]
+        id            = green
+        organizations = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_phone/index.md

@@ -0,0 +1,22 @@
+---
+title: ppl [color "phone"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "phone"
+---
+
+This section dictates the color of the output of the
+[phone](/documentation/commands/phone) command.
+
+### Example
+
+    [color "phone"]
+        star          = red
+        id            = green
+        phone_numbers = blue
+        type          = red
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_post/index.md

@@ -0,0 +1,20 @@
+---
+title: ppl [color "post"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "post"
+---
+
+This section dictates the color of the output of the
+[post](/documentation/commands/post) command.
+
+### Example
+
+    [color "post"]
+        id             = green
+        postal_address = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/color_url/index.md

@@ -0,0 +1,20 @@
+---
+title: ppl [color "url"] Configuration Guide
+layout: configuration
+section: documentation
+config_section: color "url"
+---
+
+This section dictates the color of the output of the
+[url](/documentation/commands/url) command.
+
+### Example
+
+    [color "url"]
+        id   = green
+        urls = blue
+
+### See Also
+
+* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
+

data/gh-pages/documentation/configuration/index.html

@@ -0,0 +1,8 @@
+---
+title: Configuration
+layout: page
+section: documentation
+---
+
+<p>configuration</p>
+

data/gh-pages/documentation/index.html

@@ -0,0 +1,183 @@
+---
+title: Documentation
+layout: page
+section: documentation
+---
+
+<h2>Documentation</h2>
+
+<div class="row">
+
+  <div class="span4">
+    <h3>Quick Start</h3>
+    <div class="well well-large">
+      <p>
+        Trying ppl for the first time?
+        <br />
+        Want to learn the basics?
+        <br />
+        In 30 seconds or less?
+      </p>
+
+      <p>
+        <a class="btn btn-primary" href="{{site.url}}/documentation/quick-start">
+          Get Started
+        </a>
+      </p>
+
+    </div>
+  </div>
+
+  <div class="span8">
+    <h3>Command Reference</h3>
+
+    <div class="row">
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/commands/age">age</a></li>
+          <li><a href="{{site.url}}/documentation/commands/add">add</a></li>
+          <li><a href="{{site.url}}/documentation/commands/bday">bday</a></li>
+          <li><a href="{{site.url}}/documentation/commands/completion">completion</a></li>
+          <li><a href="{{site.url}}/documentation/commands/email">email</a></li>
+          <li><a href="{{site.url}}/documentation/commands/grep">grep</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/commands/init">init</a></li>
+          <li><a href="{{site.url}}/documentation/commands/ls">ls</a></li>
+          <li><a href="{{site.url}}/documentation/commands/mutt">mutt</a></li>
+          <li><a href="{{site.url}}/documentation/commands/mv">mv</a></li>
+          <li><a href="{{site.url}}/documentation/commands/name">name</a></li>
+          <li><a href="{{site.url}}/documentation/commands/nick">nick</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/commands/org">org</a></li>
+          <li><a href="{{site.url}}/documentation/commands/phone">phone</a></li>
+          <li><a href="{{site.url}}/documentation/commands/post">post</a></li>
+          <li><a href="{{site.url}}/documentation/commands/pull">pull</a></li>
+          <li><a href="{{site.url}}/documentation/commands/push">push</a></li>
+          <li><a href="{{site.url}}/documentation/commands/remote">remote</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/commands/rm">rm</a></li>
+          <li><a href="{{site.url}}/documentation/commands/scrape">scrape</a></li>
+          <li><a href="{{site.url}}/documentation/commands/shell">shell</a></li>
+          <li><a href="{{site.url}}/documentation/commands/show">show</a></li>
+          <li><a href="{{site.url}}/documentation/commands/url">url</a></li>
+          <li><a href="{{site.url}}/documentation/commands/version">version</a></li>
+        </ul>
+      </div>
+
+    </div>
+
+  </div>
+
+</div>
+
+
+<div class="row">
+
+  <div class="span4">
+    <h3>Tips &amp; Tricks</h3>
+    <p>
+      Small bits of advice for getting the most out of ppl.
+      <br />
+      <a href="{{site.url}}/documentation/tips">Sound interesting?</a>
+    </p>
+  </div>
+
+  <div class="span8">
+    <h3>Integration Guide</h3>
+    <div class="row">
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/integration/bash">Bash</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/integration/google">Google</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/integration/mutt">Mutt</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/integration/zsh">ZSH</a></li>
+        </ul>
+      </div>
+
+    </div>
+  </div>
+
+</div>
+
+<div class="row">
+
+  <div class="span4">
+    <h3>About ppl</h3>
+    <p>
+      Wondering why ppl even exists? Whose idea it was?
+      <br />
+      <a href="{{site.url}}/documentation/about">Look no further</a>
+    </p>
+  </div>
+
+  <div class="span8">
+    <h3>Configuration Guide</h3>
+    <div class="row">
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/configuration/address_book">[address&nbsp;book]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/alias">[alias]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color">[color]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_age">[color "age"]</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/configuration/color_bday">[color "bday"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_email">[color "email"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_ls">[color "ls"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_name">[color "name"]</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/configuration/color_nick">[color "nick"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_org">[color "org"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_phone">[color&nbsp;"phone"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_post">[color "post"]</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/configuration/color_url">[color "url"]</a></li>
+        </ul>
+      </div>
+
+    </div>
+  </div>
+
+</div>
+