From 2c4bcdc58fffa8359323fa0008d60ddaba36b2ad Mon Sep 17 00:00:00 2001
From: Gilad Gray <giladgray@gmail.com>
Date: Wed, 8 Mar 2017 14:00:08 -0800
Subject: [PATCH] plugins return maps instead of arrays (#12)

* add objectify function to convert array to map

* update theme and plugins (+ namespace interfaces)

* rename css interfaces too

* ITypescriptPluginData
---
 docs/index.html           | 542 ++++++++++++++++++--------------------
 src/documentalist.ts      |  13 +
 src/plugins/css.ts        |  10 +-
 src/plugins/markdown.ts   |   8 +-
 src/plugins/typescript.ts |  17 +-
 theme/index.pug           |   9 +-
 6 files changed, 292 insertions(+), 307 deletions(-)

diff --git a/docs/index.html b/docs/index.html
index fe8a7d4d..98dcdbf3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -27,24 +27,24 @@ <h3>Documentalist</h3></a>
     <h3>Interfaces</h3><a href="#IApi">
       <div class="nav-item">IApi</div></a><a href="#IBlock">
       <div class="nav-item">IBlock</div></a><a href="#ICss">
-      <div class="nav-item">ICss</div></a><a href="#ICss">
       <div class="nav-item">ICss</div></a><a href="#ICssPluginData">
       <div class="nav-item">ICssPluginData</div></a><a href="#IDeclaration">
-      <div class="nav-item">IDeclaration</div></a><a href="#IDeclaration">
       <div class="nav-item">IDeclaration</div></a><a href="#IDocEntry">
       <div class="nav-item">IDocEntry</div></a><a href="#IFile">
       <div class="nav-item">IFile</div></a><a href="#IHeadingNode">
       <div class="nav-item">IHeadingNode</div></a><a href="#IInterfaceEntry">
-      <div class="nav-item">IInterfaceEntry</div></a><a href="#IKssPluginData">
+      <div class="nav-item">IInterfaceEntry</div></a><a href="#IKssEntry">
+      <div class="nav-item">IKssEntry</div></a><a href="#IKssExample">
+      <div class="nav-item">IKssExample</div></a><a href="#IKssPluginData">
       <div class="nav-item">IKssPluginData</div></a><a href="#IMarkdownPluginData">
       <div class="nav-item">IMarkdownPluginData</div></a><a href="#IMetadata">
       <div class="nav-item">IMetadata</div></a><a href="#IPageData">
-      <div class="nav-item">IPageData</div></a><a href="#IPageNode">
+      <div class="nav-item">IPageData</div></a><a href="#IPageMap">
+      <div class="nav-item">IPageMap</div></a><a href="#IPageNode">
       <div class="nav-item">IPageNode</div></a><a href="#IPlugin">
       <div class="nav-item">IPlugin</div></a><a href="#IPluginEntry">
       <div class="nav-item">IPluginEntry</div></a><a href="#IPropertyEntry">
       <div class="nav-item">IPropertyEntry</div></a><a href="#IRule">
-      <div class="nav-item">IRule</div></a><a href="#IRule">
       <div class="nav-item">IRule</div></a><a href="#ITag">
       <div class="nav-item">ITag</div></a><a href="#ITreeEntry">
       <div class="nav-item">ITreeEntry</div></a><a href="#ITypescriptPluginData">
@@ -84,7 +84,7 @@ <h3 id="api">API</h3>
             <tr>
               <td class="prop-name" valign="top">clearPlugins</td>
               <td class="prop-type" valign="top">
-                <pre>() =&gt; IApi&lt;void&gt;</pre><p>Returns a new instance of Documentalist with no plugins.</p>
+                <pre>() =&gt; IApi&lt;{}&gt;</pre><p>Returns a new instance of Documentalist with no plugins.</p>
 
               </td>
             </tr>
@@ -137,58 +137,57 @@ <h3 id="api">API</h3>
 <p>Documentalist uses a plugin architecture to support arbitrary file types.</p>
 
   </div>
-  <div class="hidden" data-route="IApi">
-    <h2>IApi</h2>
-      <div class="interface-block" id="IApi">
+  <div class="hidden" data-route="ITag">
+    <h2>ITag</h2>
+      <div class="interface-block" id="ITag"><p>Copyright 2017-present Palantir Technologies, Inc. All rights reserved.
+Licensed under the BSD-3 License as modified (the “License”); you may obtain
+a copy of the license in the LICENSE and PATENTS files in the root of this
+repository.
+Represents a single <code>@tag &lt;value&gt;</code> line from a file. </p>
+
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">clearPlugins</td>
+              <td class="prop-name" valign="top">tag</td>
               <td class="prop-type" valign="top">
-                <pre>() =&gt; IApi&lt;void&gt;</pre><p>Returns a new instance of Documentalist with no plugins.</p>
-
+                <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">documentFiles</td>
+              <td class="prop-name" valign="top">value</td>
               <td class="prop-type" valign="top">
-                <pre>(files: IFile[]) =&gt; any</pre><p>Iterates over all plugins, passing all matching files to each in turn.
-The output of each plugin is merged to produce the resulting
-documentation object.</p>
-<p>The return type T is a composite type has a composite type of all the
-plugin data types.</p>
-
+                <pre>string</pre>
               </td>
             </tr>
-            <tr>
-              <td class="prop-name" valign="top">documentGlobs</td>
-              <td class="prop-type" valign="top">
-                <pre>(...filesGlobs: string[]) =&gt; any</pre><p>Finds all files matching the provided variadic glob expressions and then
-runs <code>documentFiles</code> with them, emitting all the documentation data.</p>
+          </table>
+        </div>
+      </div>
+  </div>
+  <div class="hidden" data-route="IMetadata">
+    <h2>IMetadata</h2>
+      <div class="interface-block" id="IMetadata"><p>Metadata is parsed from YAML front matter in files and can contain arbitrary data.
+A few keys are understood by Documentalist and, if defined in front matter,
+will override default behavior.</p>
+<pre><code class="lang-md">---
+reference: overview
+title: &quot;Welcome to the Jungle&quot;
+---
+actual contents of file...
+</code></pre>
 
-              </td>
-            </tr>
+        <div class="interface-properties">
+          <table>
             <tr>
-              <td class="prop-name" valign="top">renderBlock</td>
+              <td class="prop-name" valign="top">reference</td>
               <td class="prop-type" valign="top">
-                <pre>(blockContent: string, reservedTagWords?: string[]) =&gt; IBlock</pre><p>Render a block of content by extracting metadata (YAML front matter) and
-splitting text content into markdown-rendered HTML strings and <code>{ tag,
-value }</code> objects.</p>
-<p>To prevent special strings like &quot;@include&quot; from being parsed, a reserved
-tag words array may be provided, in which case the line will be left as
-is.</p>
+                <pre>string</pre><p>Unique ID for addressing this page.</p>
 
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">use</td>
+              <td class="prop-name" valign="top">title</td>
               <td class="prop-type" valign="top">
-                <pre>&lt;P&gt;(pattern: string | RegExp, plugin: IPlugin&lt;P&gt;) =&gt; IApi&lt;T &amp; P&gt;</pre><p>Adds the plugin to Documentalist. Returns a new instance of Documentalist
-with a template type that includes the data from the plugin. This way the
-<code>documentFiles</code> and <code>documentGlobs</code> methods will return an object that is
-already typed to include each plugin&#39;s output.</p>
-<p>The plugin is applied to all files whose absolute path matches the
-supplied pattern.</p>
+                <pre>string</pre><p>Human-friendly title of this page, for display in the UI.#` tag</p>
 
               </td>
             </tr>
@@ -196,110 +195,142 @@ <h2>IApi</h2>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IBlock">
-    <h2>IBlock</h2>
-      <div class="interface-block" id="IBlock"><p>The output of <code>renderBlock</code> which parses a long form documentation block into
-metadata, rendered markdown, and tags.</p>
+  <div class="hidden" data-route="IPageData">
+    <h2>IPageData</h2>
+      <div class="interface-block" id="IPageData"><p>A single Documentalist page, parsed from a single source file.</p>
 
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">content</td>
+              <td class="prop-name" valign="top">absolutePath</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre><p>The original string content block.</p>
+                <pre>string</pre><p>Absolute path of source file. </p>
 
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">metadata</td>
+              <td class="prop-name" valign="top">contentRaw</td>
               <td class="prop-type" valign="top">
-                <pre>any</pre><p>Parsed YAML front matter (if any) or {}.</p>
+                <pre>string</pre><p>Raw unmodified contents of source file (excluding the metadata). </p>
 
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">renderedContent</td>
+              <td class="prop-name" valign="top">contents</td>
               <td class="prop-type" valign="top">
-                <pre>StringOrTag[]</pre><p>An array of markdown-rendered HTML or tags.</p>
+                <pre>StringOrTag[]</pre><p>Parsed nodes of source file. An array of rendered HTML strings or <code>@tag</code> objects. </p>
 
               </td>
             </tr>
-          </table>
-        </div>
-      </div>
-  </div>
-  <div class="hidden" data-route="ICss">
-    <h2>ICss</h2>
-      <div class="interface-block" id="ICss">
-        <div class="interface-properties">
-          <table>
             <tr>
-              <td class="prop-name" valign="top">filePath</td>
+              <td class="prop-name" valign="top">metadata</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre>
+                <pre>IMetadata</pre><p>Arbitrary YAML metadata parsed from front matter of source file </p>
+
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">rules</td>
+              <td class="prop-name" valign="top">reference</td>
               <td class="prop-type" valign="top">
-                <pre>IRule[]</pre>
+                <pre>string</pre><p>Unique identifier for addressing this page. </p>
+
+              </td>
+            </tr>
+            <tr>
+              <td class="prop-name" valign="top">title</td>
+              <td class="prop-type" valign="top">
+                <pre>string</pre><p>Human-friendly title of this page. </p>
+
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="ICss">
-    <h2>ICss</h2>
-      <div class="interface-block" id="ICss">
+  <div class="hidden" data-route="ITreeEntry">
+    <h2>ITreeEntry</h2>
+      <div class="interface-block" id="ITreeEntry"><p>One page entry in a layout tree. </p>
+
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">filePath</td>
+              <td class="prop-name" valign="top">depth</td>
+              <td class="prop-type" valign="top">
+                <pre>number</pre>
+              </td>
+            </tr>
+            <tr>
+              <td class="prop-name" valign="top">reference</td>
               <td class="prop-type" valign="top">
                 <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">rules</td>
+              <td class="prop-name" valign="top">title</td>
               <td class="prop-type" valign="top">
-                <pre>IRule[]</pre>
+                <pre>string</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="ICssPluginData">
-    <h2>ICssPluginData</h2>
-      <div class="interface-block" id="ICssPluginData">
+  <div class="hidden" data-route="IPageNode">
+    <h2>IPageNode</h2>
+      <div class="interface-block" id="IPageNode"><p>A page has ordered children composed of <code>@#+</code> and <code>@page</code> tags. </p>
+
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">css</td>
+              <td class="prop-name" valign="top">children</td>
               <td class="prop-type" valign="top">
-                <pre>ICss[]</pre>
+                <pre>(IPageNode | IHeadingNode)[]</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IDeclaration">
-    <h2>IDeclaration</h2>
-      <div class="interface-block" id="IDeclaration">
+  <div class="hidden" data-route="IHeadingNode">
+    <h2>IHeadingNode</h2>
+      <div class="interface-block" id="IHeadingNode"><p>An <code>@#+</code> tag belongs to a specific page. </p>
+
+        <div class="interface-properties">
+          <table>
+          </table>
+        </div>
+      </div>
+  </div>
+  <div class="hidden" data-route="IFile">
+    <h2>IFile</h2>
+      <div class="interface-block" id="IFile">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">prop</td>
+              <td class="prop-name" valign="top">path</td>
               <td class="prop-type" valign="top">
                 <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">value</td>
+              <td class="prop-name" valign="top">read</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre>
+                <pre>() =&gt; string</pre>
+              </td>
+            </tr>
+          </table>
+        </div>
+      </div>
+  </div>
+  <div class="hidden" data-route="IPlugin">
+    <h2>IPlugin</h2>
+      <div class="interface-block" id="IPlugin">
+        <div class="interface-properties">
+          <table>
+            <tr>
+              <td class="prop-name" valign="top">compile</td>
+              <td class="prop-type" valign="top">
+                <pre>(doc: Documentalist&lt;T&gt;, files: IFile[]) =&gt; any</pre>
               </td>
             </tr>
           </table>
@@ -327,37 +358,37 @@ <h2>IDeclaration</h2>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IDocEntry">
-    <h2>IDocEntry</h2>
-      <div class="interface-block" id="IDocEntry">
+  <div class="hidden" data-route="IRule">
+    <h2>IRule</h2>
+      <div class="interface-block" id="IRule">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">documentation</td>
+              <td class="prop-name" valign="top">comment</td>
               <td class="prop-type" valign="top">
-                <pre>IBlock</pre>
+                <pre>StringOrTag[]</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">fileName</td>
+              <td class="prop-name" valign="top">commentRaw</td>
               <td class="prop-type" valign="top">
                 <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">name</td>
+              <td class="prop-name" valign="top">declarations</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre>
+                <pre>IDeclaration[]</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">tags</td>
+              <td class="prop-name" valign="top">metadata</td>
               <td class="prop-type" valign="top">
-                <pre>IJsDocTags</pre>
+                <pre>any</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">type</td>
+              <td class="prop-name" valign="top">selector</td>
               <td class="prop-type" valign="top">
                 <pre>string</pre>
               </td>
@@ -366,381 +397,320 @@ <h2>IDocEntry</h2>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IFile">
-    <h2>IFile</h2>
-      <div class="interface-block" id="IFile">
+  <div class="hidden" data-route="ICss">
+    <h2>ICss</h2>
+      <div class="interface-block" id="ICss">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">path</td>
+              <td class="prop-name" valign="top">filePath</td>
               <td class="prop-type" valign="top">
                 <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">read</td>
+              <td class="prop-name" valign="top">rules</td>
               <td class="prop-type" valign="top">
-                <pre>() =&gt; string</pre>
+                <pre>IRule[]</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IHeadingNode">
-    <h2>IHeadingNode</h2>
-      <div class="interface-block" id="IHeadingNode"><p>An <code>@#+</code> tag belongs to a specific page. </p>
-
+  <div class="hidden" data-route="ICssPluginData">
+    <h2>ICssPluginData</h2>
+      <div class="interface-block" id="ICssPluginData">
         <div class="interface-properties">
           <table>
+            <tr>
+              <td class="prop-name" valign="top">css</td>
+              <td class="prop-type" valign="top">
+                <pre>ICss[]</pre>
+              </td>
+            </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IInterfaceEntry">
-    <h2>IInterfaceEntry</h2>
-      <div class="interface-block" id="IInterfaceEntry">
+  <div class="hidden" data-route="IKssEntry">
+    <h2>IKssEntry</h2>
+      <div class="interface-block" id="IKssEntry">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">extends</td>
+              <td class="prop-name" valign="top">documentation</td>
               <td class="prop-type" valign="top">
-                <pre>string[]</pre>
+                <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">properties</td>
+              <td class="prop-name" valign="top">markup</td>
               <td class="prop-type" valign="top">
-                <pre>IPropertyEntry[]</pre>
+                <pre>string</pre>
+              </td>
+            </tr>
+            <tr>
+              <td class="prop-name" valign="top">reference</td>
+              <td class="prop-type" valign="top">
+                <pre>string</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IKssPluginData">
-    <h2>IKssPluginData</h2>
-      <div class="interface-block" id="IKssPluginData">
+  <div class="hidden" data-route="IKssExample">
+    <h2>IKssExample</h2>
+      <div class="interface-block" id="IKssExample">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">css</td>
+              <td class="prop-name" valign="top">modifiers</td>
               <td class="prop-type" valign="top">
-                <pre>ICss[]</pre>
+                <pre>IKssEntry[]</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IMarkdownPluginData">
-    <h2>IMarkdownPluginData</h2>
-      <div class="interface-block" id="IMarkdownPluginData">
+  <div class="hidden" data-route="IKssPluginData">
+    <h2>IKssPluginData</h2>
+      <div class="interface-block" id="IKssPluginData">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">docs</td>
+              <td class="prop-name" valign="top">css</td>
               <td class="prop-type" valign="top">
-                <pre>IPageMap</pre>
+                <pre>{ [name: string]: IKssExample; }</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IMetadata">
-    <h2>IMetadata</h2>
-      <div class="interface-block" id="IMetadata"><p>Metadata is parsed from YAML front matter in files and can contain arbitrary data.
-A few keys are understood by Documentalist and, if defined in front matter,
-will override default behavior.</p>
-<pre><code class="lang-md">---
-reference: overview
-title: &quot;Welcome to the Jungle&quot;
----
-actual contents of file...
-</code></pre>
-
+  <div class="hidden" data-route="IPageMap">
+    <h2>IPageMap</h2>
+      <div class="interface-block" id="IPageMap">
         <div class="interface-properties">
           <table>
-            <tr>
-              <td class="prop-name" valign="top">reference</td>
-              <td class="prop-type" valign="top">
-                <pre>string</pre><p>Unique ID for addressing this page.</p>
-
-              </td>
-            </tr>
-            <tr>
-              <td class="prop-name" valign="top">title</td>
-              <td class="prop-type" valign="top">
-                <pre>string</pre><p>Human-friendly title of this page, for display in the UI.#` tag</p>
-
-              </td>
-            </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IPageData">
-    <h2>IPageData</h2>
-      <div class="interface-block" id="IPageData"><p>A single Documentalist page, parsed from a single source file.</p>
-
+  <div class="hidden" data-route="IMarkdownPluginData">
+    <h2>IMarkdownPluginData</h2>
+      <div class="interface-block" id="IMarkdownPluginData">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">absolutePath</td>
-              <td class="prop-type" valign="top">
-                <pre>string</pre><p>Absolute path of source file. </p>
-
-              </td>
-            </tr>
-            <tr>
-              <td class="prop-name" valign="top">contentRaw</td>
+              <td class="prop-name" valign="top">docs</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre><p>Raw unmodified contents of source file (excluding the metadata). </p>
-
+                <pre>IPageMap</pre>
               </td>
             </tr>
+          </table>
+        </div>
+      </div>
+  </div>
+  <div class="hidden" data-route="IDocEntry">
+    <h2>IDocEntry</h2>
+      <div class="interface-block" id="IDocEntry">
+        <div class="interface-properties">
+          <table>
             <tr>
-              <td class="prop-name" valign="top">contents</td>
+              <td class="prop-name" valign="top">documentation</td>
               <td class="prop-type" valign="top">
-                <pre>StringOrTag[]</pre><p>Parsed nodes of source file. An array of rendered HTML strings or <code>@tag</code> objects. </p>
-
+                <pre>IBlock</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">metadata</td>
+              <td class="prop-name" valign="top">fileName</td>
               <td class="prop-type" valign="top">
-                <pre>IMetadata</pre><p>Arbitrary YAML metadata parsed from front matter of source file </p>
-
+                <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">reference</td>
+              <td class="prop-name" valign="top">name</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre><p>Unique identifier for addressing this page. </p>
-
+                <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">title</td>
+              <td class="prop-name" valign="top">tags</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre><p>Human-friendly title of this page. </p>
-
+                <pre>IJsDocTags</pre>
               </td>
             </tr>
-          </table>
-        </div>
-      </div>
-  </div>
-  <div class="hidden" data-route="IPageNode">
-    <h2>IPageNode</h2>
-      <div class="interface-block" id="IPageNode"><p>A page has ordered children composed of <code>@#+</code> and <code>@page</code> tags. </p>
-
-        <div class="interface-properties">
-          <table>
             <tr>
-              <td class="prop-name" valign="top">children</td>
+              <td class="prop-name" valign="top">type</td>
               <td class="prop-type" valign="top">
-                <pre>(IPageNode | IHeadingNode)[]</pre>
+                <pre>string</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IPlugin">
-    <h2>IPlugin</h2>
-      <div class="interface-block" id="IPlugin">
+  <div class="hidden" data-route="IPropertyEntry">
+    <h2>IPropertyEntry</h2>
+      <div class="interface-block" id="IPropertyEntry">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">compile</td>
+              <td class="prop-name" valign="top">optional</td>
               <td class="prop-type" valign="top">
-                <pre>(doc: Documentalist&lt;T&gt;, files: IFile[]) =&gt; any</pre>
+                <pre>boolean</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IPluginEntry">
-    <h2>IPluginEntry</h2>
-      <div class="interface-block" id="IPluginEntry"><p>Plugins are stored with the regex used to match against file paths.</p>
-
+  <div class="hidden" data-route="IInterfaceEntry">
+    <h2>IInterfaceEntry</h2>
+      <div class="interface-block" id="IInterfaceEntry">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">pattern</td>
+              <td class="prop-name" valign="top">extends</td>
               <td class="prop-type" valign="top">
-                <pre>RegExp</pre>
+                <pre>string[]</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">plugin</td>
+              <td class="prop-name" valign="top">properties</td>
               <td class="prop-type" valign="top">
-                <pre>IPlugin&lt;T&gt;</pre>
+                <pre>IPropertyEntry[]</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IPropertyEntry">
-    <h2>IPropertyEntry</h2>
-      <div class="interface-block" id="IPropertyEntry">
+  <div class="hidden" data-route="ITypescriptPluginData">
+    <h2>ITypescriptPluginData</h2>
+      <div class="interface-block" id="ITypescriptPluginData">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">optional</td>
+              <td class="prop-name" valign="top">ts</td>
               <td class="prop-type" valign="top">
-                <pre>boolean</pre>
+                <pre>{ [name: string]: IInterfaceEntry; }</pre>
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IRule">
-    <h2>IRule</h2>
-      <div class="interface-block" id="IRule">
+  <div class="hidden" data-route="IApi">
+    <h2>IApi</h2>
+      <div class="interface-block" id="IApi">
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">comment</td>
+              <td class="prop-name" valign="top">clearPlugins</td>
               <td class="prop-type" valign="top">
-                <pre>StringOrTag[]</pre>
+                <pre>() =&gt; IApi&lt;{}&gt;</pre><p>Returns a new instance of Documentalist with no plugins.</p>
+
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">commentRaw</td>
+              <td class="prop-name" valign="top">documentFiles</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre>
+                <pre>(files: IFile[]) =&gt; any</pre><p>Iterates over all plugins, passing all matching files to each in turn.
+The output of each plugin is merged to produce the resulting
+documentation object.</p>
+<p>The return type T is a composite type has a composite type of all the
+plugin data types.</p>
+
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">declarations</td>
+              <td class="prop-name" valign="top">documentGlobs</td>
               <td class="prop-type" valign="top">
-                <pre>IDeclaration[]</pre>
+                <pre>(...filesGlobs: string[]) =&gt; any</pre><p>Finds all files matching the provided variadic glob expressions and then
+runs <code>documentFiles</code> with them, emitting all the documentation data.</p>
+
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">metadata</td>
+              <td class="prop-name" valign="top">renderBlock</td>
               <td class="prop-type" valign="top">
-                <pre>any</pre>
+                <pre>(blockContent: string, reservedTagWords?: string[]) =&gt; IBlock</pre><p>Render a block of content by extracting metadata (YAML front matter) and
+splitting text content into markdown-rendered HTML strings and <code>{ tag,
+value }</code> objects.</p>
+<p>To prevent special strings like &quot;@include&quot; from being parsed, a reserved
+tag words array may be provided, in which case the line will be left as
+is.</p>
+
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">selector</td>
+              <td class="prop-name" valign="top">use</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre>
+                <pre>&lt;P&gt;(pattern: string | RegExp, plugin: IPlugin&lt;P&gt;) =&gt; IApi&lt;T &amp; P&gt;</pre><p>Adds the plugin to Documentalist. Returns a new instance of Documentalist
+with a template type that includes the data from the plugin. This way the
+<code>documentFiles</code> and <code>documentGlobs</code> methods will return an object that is
+already typed to include each plugin&#39;s output.</p>
+<p>The plugin is applied to all files whose absolute path matches the
+supplied pattern.</p>
+
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="IRule">
-    <h2>IRule</h2>
-      <div class="interface-block" id="IRule">
+  <div class="hidden" data-route="IBlock">
+    <h2>IBlock</h2>
+      <div class="interface-block" id="IBlock"><p>The output of <code>renderBlock</code> which parses a long form documentation block into
+metadata, rendered markdown, and tags.</p>
+
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">comment</td>
-              <td class="prop-type" valign="top">
-                <pre>StringOrTag[]</pre>
-              </td>
-            </tr>
-            <tr>
-              <td class="prop-name" valign="top">commentRaw</td>
-              <td class="prop-type" valign="top">
-                <pre>string</pre>
-              </td>
-            </tr>
-            <tr>
-              <td class="prop-name" valign="top">declarations</td>
+              <td class="prop-name" valign="top">content</td>
               <td class="prop-type" valign="top">
-                <pre>IDeclaration[]</pre>
+                <pre>string</pre><p>The original string content block.</p>
+
               </td>
             </tr>
             <tr>
               <td class="prop-name" valign="top">metadata</td>
               <td class="prop-type" valign="top">
-                <pre>any</pre>
-              </td>
-            </tr>
-            <tr>
-              <td class="prop-name" valign="top">selector</td>
-              <td class="prop-type" valign="top">
-                <pre>string</pre>
-              </td>
-            </tr>
-          </table>
-        </div>
-      </div>
-  </div>
-  <div class="hidden" data-route="ITag">
-    <h2>ITag</h2>
-      <div class="interface-block" id="ITag"><p>Copyright 2017-present Palantir Technologies, Inc. All rights reserved.
-Licensed under the BSD-3 License as modified (the “License”); you may obtain
-a copy of the license in the LICENSE and PATENTS files in the root of this
-repository.
-Represents a single <code>@tag &lt;value&gt;</code> line from a file. </p>
+                <pre>any</pre><p>Parsed YAML front matter (if any) or {}.</p>
 
-        <div class="interface-properties">
-          <table>
-            <tr>
-              <td class="prop-name" valign="top">tag</td>
-              <td class="prop-type" valign="top">
-                <pre>string</pre>
               </td>
             </tr>
             <tr>
-              <td class="prop-name" valign="top">value</td>
+              <td class="prop-name" valign="top">renderedContent</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre>
+                <pre>StringOrTag[]</pre><p>An array of markdown-rendered HTML or tags.</p>
+
               </td>
             </tr>
           </table>
         </div>
       </div>
   </div>
-  <div class="hidden" data-route="ITreeEntry">
-    <h2>ITreeEntry</h2>
-      <div class="interface-block" id="ITreeEntry"><p>One page entry in a layout tree. </p>
+  <div class="hidden" data-route="IPluginEntry">
+    <h2>IPluginEntry</h2>
+      <div class="interface-block" id="IPluginEntry"><p>Plugins are stored with the regex used to match against file paths.</p>
 
         <div class="interface-properties">
           <table>
             <tr>
-              <td class="prop-name" valign="top">depth</td>
-              <td class="prop-type" valign="top">
-                <pre>number</pre>
-              </td>
-            </tr>
-            <tr>
-              <td class="prop-name" valign="top">reference</td>
-              <td class="prop-type" valign="top">
-                <pre>string</pre>
-              </td>
-            </tr>
-            <tr>
-              <td class="prop-name" valign="top">title</td>
+              <td class="prop-name" valign="top">pattern</td>
               <td class="prop-type" valign="top">
-                <pre>string</pre>
+                <pre>RegExp</pre>
               </td>
             </tr>
-          </table>
-        </div>
-      </div>
-  </div>
-  <div class="hidden" data-route="ITypescriptPluginData">
-    <h2>ITypescriptPluginData</h2>
-      <div class="interface-block" id="ITypescriptPluginData">
-        <div class="interface-properties">
-          <table>
             <tr>
-              <td class="prop-name" valign="top">ts</td>
+              <td class="prop-name" valign="top">plugin</td>
               <td class="prop-type" valign="top">
-                <pre>IInterfaceEntry[]</pre>
+                <pre>IPlugin&lt;T&gt;</pre>
               </td>
             </tr>
           </table>
diff --git a/src/documentalist.ts b/src/documentalist.ts
index 74594f75..4d33e5d3 100644
--- a/src/documentalist.ts
+++ b/src/documentalist.ts
@@ -62,6 +62,12 @@ export interface IApi<T> {
      */
     documentFiles: (files: IFile[]) => Promise<T>;
 
+    /**
+     * Converts an array of entries into a map of key to entry, using given
+     * callback to extract key from each item.
+     */
+    objectify: <T>(array: T[], getKey: (item: T) => string) => { [key: string]: T };
+
     /**
      * Render a block of content by extracting metadata (YAML front matter) and
      * splitting text content into markdown-rendered HTML strings and `{ tag,
@@ -172,6 +178,13 @@ export class Documentalist<T> implements IApi<T> {
         return documentation;
     }
 
+    public objectify<T>(array: T[], getKey: (item: T) => string) {
+        return array.reduce((obj, item) => {
+            obj[getKey(item)] = item;
+            return obj;
+        }, {} as { [key: string]: T });
+    }
+
     public renderBlock(blockContent: string, reservedTagWords = RESERVED_WORDS): IBlock {
         const { content, metadata } = this.extractMetadata(blockContent);
         const renderedContent = this.renderContents(content, reservedTagWords);
diff --git a/src/plugins/css.ts b/src/plugins/css.ts
index 92dbaea6..42b32cc9 100644
--- a/src/plugins/css.ts
+++ b/src/plugins/css.ts
@@ -13,22 +13,22 @@ import { Documentalist } from "..";
 import { StringOrTag } from "../client";
 import { IFile, IPlugin } from "./plugin";
 
-export interface IDeclaration {
+export interface ICssDeclaration {
     prop: string;
     value: string;
 }
 
-export interface IRule {
+export interface ICssRule {
     comment?: StringOrTag[];
     commentRaw?: string;
     selector: string;
-    declarations: IDeclaration[];
+    declarations: ICssDeclaration[];
     metadata?: any;
 }
 
 export interface ICss {
     filePath: string;
-    rules: IRule[];
+    rules: ICssRule[];
 }
 
 export interface ICssPluginData {
@@ -56,7 +56,7 @@ export class CssPlugin implements IPlugin<ICssPluginData> {
                 const ruleResult = {
                     declarations: [],
                     selector: rule.selector,
-                } as IRule;
+                } as ICssRule;
 
                 const prevNode = rule.prev();
                 if (prevNode != null && prevNode.type === "comment") {
diff --git a/src/plugins/markdown.ts b/src/plugins/markdown.ts
index 177b68a6..6d42acac 100644
--- a/src/plugins/markdown.ts
+++ b/src/plugins/markdown.ts
@@ -10,12 +10,10 @@ import { IPageData, StringOrTag } from "../client";
 import { makePage } from "../page";
 import { IFile, IPlugin } from "./plugin";
 
-export interface IPageMap {
-    [key: string]: IPageData;
-}
-
 export interface IMarkdownPluginData {
-    docs: IPageMap;
+    docs: {
+        [key: string]: IPageData;
+    };
 }
 
 export class MarkdownPlugin implements IPlugin<IMarkdownPluginData> {
diff --git a/src/plugins/typescript.ts b/src/plugins/typescript.ts
index ca3f9d9f..19a820eb 100644
--- a/src/plugins/typescript.ts
+++ b/src/plugins/typescript.ts
@@ -9,7 +9,7 @@ import tsdoc, { IJsDocTags } from "ts-quick-docs";
 import { Documentalist, IBlock } from "..";
 import { IFile, IPlugin } from "./plugin";
 
-export interface IDocEntry {
+export interface ITsDocEntry {
     documentation: IBlock;
     fileName: string;
     name: string;
@@ -17,29 +17,32 @@ export interface IDocEntry {
     type: string;
 }
 
-export interface IPropertyEntry extends IDocEntry {
+export interface ITsPropertyEntry extends ITsDocEntry {
     optional?: boolean;
 }
 
-export interface IInterfaceEntry extends IDocEntry {
+export interface ITsInterfaceEntry extends ITsDocEntry {
     extends?: string[];
-    properties: IPropertyEntry[];
+    properties: ITsPropertyEntry[];
 }
 
 export interface ITypescriptPluginData {
-    ts: IInterfaceEntry[];
+    ts: {
+        [name: string]: ITsInterfaceEntry;
+    };
 }
 
 export class TypescriptPlugin implements IPlugin<ITypescriptPluginData> {
     public compile(documentalist: Documentalist<ITypescriptPluginData>, files: IFile[]) {
-        const ts = tsdoc.fromFiles(files.map((f) => f.path), {}).map<IInterfaceEntry>((entry) => ({
+        const entries = tsdoc.fromFiles(files.map((f) => f.path), {}).map<ITsInterfaceEntry>((entry) => ({
             ...entry,
             documentation: documentalist.renderBlock(entry.documentation),
-            properties: entry.properties!.map<IPropertyEntry>((prop) => ({
+            properties: entry.properties!.map<ITsPropertyEntry>((prop) => ({
                 ...prop,
                 documentation: documentalist.renderBlock(prop.documentation),
             })),
         }));
+        const ts = documentalist.objectify(entries, (e) => e.name);
         return { ts };
     }
 }
diff --git a/theme/index.pug b/theme/index.pug
index 37b2dbed..7fc014e3 100644
--- a/theme/index.pug
+++ b/theme/index.pug
@@ -1,4 +1,4 @@
-- ts.sort((a, b) => a.name.localeCompare(b.name))
+- var toc = Object.keys(ts).sort((a, b) => a.localeCompare(b))
 
 html
   head
@@ -25,7 +25,8 @@ body
       h3 Documentalist
 
     h3 Interfaces
-    for iface in ts
+    each ifaceName in toc
+      - var iface = ts[ifaceName]
       if iface.type == "interface"
         a(href='#' + iface.name)
           .nav-item= iface.name
@@ -60,10 +61,10 @@ body
       if typeof block === "string"
         | !{block}
       else if block.tag === "interface"
-        - var iface = ts.find((i) => i.name === block.value);
+        - var iface = ts[block.value]
         +interface(iface)
 
-  for iface in ts
+  each iface in ts
     if iface.type == "interface"
       .hidden(data-route=iface.name)
         h2= iface.name