Docs for new linkify-html interface

_config.yml

@@ -10,7 +10,7 @@ baseurl: "/linkifyjs" # the subpath of your site, e.g. /blog/
 url: "http://soapbox.github.io" # the base hostname & protocol for your site
 twitter_username: SoapBoxHQ
 github_username:  SoapBox
-version: v2.0.0-beta.5
+version: v2.0.0-beta.7
 
 # Build settings
 markdown: kramdown

_layouts/doc.html

@@ -10,8 +10,9 @@
         <li><a href="linkify.html"><strong>linkify</strong></a></li>
         <ul>
           <li><a href="linkify-jquery.html">linkify-jquery</a></li>
-          <li><a href="linkify-string.html">linkify-string</a></li>
+          <li><a href="linkify-html.html">linkify-html</a></li>
           <li><a href="linkify-element.html">linkify-element</a></li>
+          <li><a href="linkify-string.html">linkify-string</a></li>
         </ul>
         <li><strong><a href="plugins.html">Plugins</a></strong></li>
         <ul>

docs/index.md

@@ -71,13 +71,13 @@ npm install linkifyjs
 {% highlight js %}
 var linkify = require('linkifyjs');
 require('linkifyjs/plugin/hashtag')(linkify); // optional
-var linkifyStr = require('linkifyjs/string');
+var linkifyHtml = require('linkifyjs/html');
 {% endhighlight %}
 
 ### Example string usage
 
 {% highlight js %}
-linkifyStr('The site github.com is #awesome.', {
+linkifyHtml('The site github.com is #awesome.', {
   defaultProtocol: 'https'
 });
 {% endhighlight %}

docs/linkify-html.md

@@ -0,0 +1,66 @@
+---
+layout: doc
+title: linkify-html · Documentation
+---
+
+Interface for replacing links with anchor tags within JavaScript strings containing HTML.
+
+#### Jump to
+
+* [Installation](#installation)
+  * [Node.js/io.js/Browserify](#nodejsiojsbrowserify)
+  * [AMD](#amd)
+  * [Browser globals](#browser-globals)
+* [Usage](#usage)
+
+### Installation
+
+### Node.js/io.js/Browserify
+
+```
+npm install linkifyjs
+```
+
+{% highlight js %}
+var linkifyHtml = require('linkifyjs/html');
+{% endhighlight %}
+
+### AMD
+
+{% highlight html %}
+<script src="linkify.amd.js"></script>
+<script src="linkify-html.amd.js"></script>
+<script>
+  require(['linkify-html'], function (linkifyHtml) {
+    // …
+  });
+</script>
+{% endhighlight %}
+
+### Browser globals
+
+{% highlight html %}
+<script src="linkify.js"></script>
+<script src="linkify-html.js"></script>
+{% endhighlight %}
+
+## Usage
+
+{% highlight js %}
+var options = {/* … */};
+var str = '<p>For help with GitHub.com, please email support@github.com</p>';
+linkifyHtml(str, options);
+{% endhighlight %}
+
+Returns
+
+{% highlight js %}
+'<p>For help with <a href="http://github.com" target="_blank">GitHub.com</a>, please email <a href="mailto:support@github.com">support@github.com</a></p>'
+{% endhighlight %}
+
+**Params**
+
+* _`String`_ **`str`** String to linkify
+* _`Object`_ [**`options`**] [Options](options.html) hash
+
+**Returns** _`String`_ Linkified htmlString

docs/linkify-string.md

@@ -3,7 +3,9 @@ layout: doc
 title: linkify-string · Documentation
 ---
 
-Interface for replacing links within native strings with anchor tags. Note that this function will ***not*** parse HTML strings properly - use [`linkify-element`](linkify-element.html) or [`linkify-jquery`](linkify-jquery.html) instead.
+Interface for replacing links with anchor tags within JavaScript strings.
+
+Note that this function will ***not*** parse HTML strings properly - use [`linkify-html`](linkify-html.html) instead. Alternatively, if you're using linkify with a DOM, use [`linkify-jquery`](linkify-html.html) or [`linkify-element`](linkify-element.html)
 
 #### Jump to
 
@@ -66,4 +68,3 @@ Returns
 * _`Object`_ [**`options`**] [Options](options.html) hash
 
 **Returns** _`String`_ Linkified string
-

index.html

@@ -38,17 +38,12 @@ <h3>1. Linkify some HTML</h3>
   <div class="col-sm-9">
     <div class="well demo-well" data-linkify-demo-target="demo-1-linkifier" >
       <p class="h1">Why Leaders Need Trust and How To Earn It</p>
-      <p class="entry-meta"> by Will Campbell (Website: http://soapboxhq.com/blog/author/willcampbell )</p>
+      <p class="entry-meta"> by Will Campbell (Website: http://soapboxhq.com/blog/author/willcampbell)</p>
       <p><time class="updated" datetime="2015-11-18" itemprop="datePublished">November 18, 2015</time></p>
-
       <p>It’s something we all intuitively know: Good leaders are trusted by their employees. A happy, engaged, productive workforce is built on trust, and trust in the person leading the charge is a vital part of this.</p>
-
-     <p>Yet <strong>trust isn’t working for many organizations</strong>. A whopping 60 percent of employees don’t trust their workplace ( http://interactionassociates.com/insights/research/building-workplace-trust-201415 ). And this distrust is holding back productivity ( http://www.inc.com/penny-herscher/5-ways-trust-impacts-your-productivity-in-the-office.html ) and <a href="http://soapboxhq.com/blog/why-trust-is-the-core-of-employee-engagement" target="_blank">wounding employee engagement</a>.</p>
-
-    <p><strong>Leaders need to start building trust</strong>. In this post you’ll learn more about why trust should be a priority, what Carlos Ghosn can teach us, and get&nbsp;<strong>five tips on how to earn trust</strong>.</p>
-
-    <p>Read more at <strong>http://soapboxhq.com/blog/why-leaders-need-trust-and-how-to-earn-it</strong>. If you have any questions, reach out at info@soapboxhq.com</p>
-
+      <p>Yet <strong>trust isn’t working for many organizations</strong>. A whopping 60 percent of employees don’t trust their workplace (http://interactionassociates.com/insights/research/building-workplace-trust-201415). And this distrust is holding back productivity (http://www.inc.com/penny-herscher/5-ways-trust-impacts-your-productivity-in-the-office.html) and <a href="http://soapboxhq.com/blog/why-trust-is-the-core-of-employee-engagement" target="_blank">wounding employee engagement</a>.</p>
+      <p><strong>Leaders need to start building trust</strong>. In this post you’ll learn more about why trust should be a priority, what Carlos Ghosn can teach us, and get <strong>five tips on how to earn trust</strong>.</p>
+      <p>Read more at <strong>http://soapboxhq.com/blog/why-leaders-need-trust-and-how-to-earn-it</strong>. If you have any questions, reach out at info@soapboxhq.com</p>
     </div>
   </div>