Migrate docs into main repository

tapjs · Dec 1, 2017 · 9fcfd52 · 9fcfd52
1 parent f189c50
commit 9fcfd52
Show file tree

Hide file tree

Showing 35 changed files with 5,372 additions and 0 deletions.
diff --git a/docs/100/index.md b/docs/100/index.md
@@ -0,0 +1,52 @@
+---
+layout: layout
+---
+
+# The TAP 100
+
+These modules use the `--100` flag to run tests with 100%
+[coverage](/coverage/) of all lines, branches, statements, and
+functions.
+
+To add yours to the list, send a [pull
+request](https://github.com/tapjs/node-tap/blob/gh-pages/100/index.md)
+to add it to the docs.
+
+* [abbrev](https://www.npmjs.com/package/abbrev)
+* [casern](https://www.npmjs.com/package/casern)
+* [color-support](https://www.npmjs.com/package/color-support)
+* [contentfs](https://www.npmjs.com/package/contentfs)
+* [events-to-array](https://www.npmjs.com/package/events-to-array)
+* [express-jwt-permissions](https://www.npmjs.com/package/express-jwt-permissions)
+* [fs-exists-cached](https://www.npmjs.com/package/fs-exists-cached)
+* [fs-minipass](https://www.npmjs.com/package/fs-minipass)
+* [fs-readstream-seek](https://www.npmjs.com/package/fs-readstream-seek)
+* [function-loop](https://www.npmjs.com/package/function-loop)
+* [hoodie](https://www.npmjs.com/package/hoodie)
+* [icepick](https://www.npmjs.com/package/icepick)
+* [ignore-walk](https://www.npmjs.com/package/ignore-walk)
+* [inflight](https://www.npmjs.com/package/inflight)
+* [ini](https://www.npmjs.com/package/ini)
+* [isexe](https://www.npmjs.com/package/isexe)
+* [lru-cache](https://www.npmjs.com/package/lru-cache)
+* [lucass](https://www.npmjs.com/package/lucass)
+* [minipass](https://www.npmjs.com/package/minipass)
+* [minizlib](https://www.npmjs.com/package/minizlib)
+* [mutate-fs](https://www.npmjs.com/package/mutate-fs)
+* [natives](https://www.npmjs.com/package/natives)
+* [npm-bundled](https://www.npmjs.com/package/npm-bundled)
+* [npm-packlist](https://www.npmjs.com/package/npm-packlist)
+* [stack-utils](https://www.npmjs.com/package/stack-utils)
+* [t-up](https://www.npmjs.com/package/t-up)
+* [tap-parser](https://www.npmjs.com/package/tap-parser)
+* [tap](/)
+* [tapromise](https://www.npmjs.com/package/tapromise)
+* [tapsert](https://www.npmjs.com/package/tapsert)
+* [tapshot](https://www.npmjs.com/package/tapshot)
+* [tar](https://www.npmjs.com/package/tar)
+* [tmatch](https://www.npmjs.com/package/tmatch)
+* [touch](https://www.npmjs.com/package/touch)
+* [trivial-deferred](https://www.npmjs.com/package/trivial-deferred)
+* [tsame](https://www.npmjs.com/package/tsame)
+* [yallist](https://www.npmjs.com/package/yallist)
+* [yapool](https://www.npmjs.com/package/yapool)
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+www.node-tap.org
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'github-pages'
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,2 @@
+run:
+	bundle exec jekyll serve
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,49 @@
+title: "Node Tap"
+description: A Test-Anything-Protocol library for Node.js
+links:
+  - name: "Index"
+    url: "/"
+  - name: "Getting Started"
+    url: "/basics/"
+  - name: "API"
+    url: "/api/"
+    links:
+    - name: "Asserts"
+      url: "/asserts/"
+    - name: "Promises"
+      url: "/promises/"
+    - name: "Subtests"
+      url: "/subtests/"
+    - name: "Parallel Tests"
+      url: "/parallel/"
+    - name: "Snapshot Testing"
+      url: "/snapshots/"
+    - name: "Filtering Tests: grep"
+      url: "/grep/"
+    - name: "Filtering Tests: only"
+      url: "/only/"
+    - name: "Mocha-like DSL"
+      url: "/mochalike/"
+    - name: "Advanced"
+      url: "/advanced/"
+  - name: "CLI"
+    url: "/cli/"
+  - name: "The Protocol"
+    url: "/tap-format/"
+  - name: "Reporting"
+    url: "/reporting/"
+  - name: "Coverage"
+    url: "/coverage/"
+  - name: "Change Log"
+    url: "/changelog/"
+  - name: "GitHub Repo"
+    url: "https://github.com/tapjs/node-tap"
+
+# Build settings
+markdown: kramdown
+markdown_ext:  md
+
+kramdown:
+  input: GFM
+  hard_wrap: false
+  syntax_highlighter: rouge
diff --git a/docs/_layouts/layout.html b/docs/_layouts/layout.html
@@ -0,0 +1,165 @@
+<!doctype html>
+<title>{{ site.title }}</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<style>
+html {
+  display: block;
+  font-family: sans-serif;
+  padding: 0 1em;
+  margin: 0 auto;
+  border-top: 10px solid #f7df1e;
+  line-height:1.5;
+  color:#333;
+  position:relative;
+}
+
+html::before {
+  width:100%;
+  display:block;
+  position:fixed;
+  top:0;
+  left:0;
+  height:10px;
+  background:#f7df1e;
+  content: " ";
+}
+
+body {
+  padding:0;
+  margin: 0;
+}
+
+a:hover, a:active, a:focus {
+  color: red;
+}
+
+code, pre, kbd {
+  font-size: 100%;
+  font-family: Triplicate T4, Fira Mono OT, Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospacek;
+}
+
+section.side {
+  display: block;
+  padding:0;
+  min-height:100px;
+  margin: 0;
+  width:100%;
+}
+
+.side h2, .side p {
+  margin-top: 0;
+}
+
+section.side li {
+  display: inline;
+}
+
+section.side ul {
+  display: block;
+  overflow:auto;
+}
+
+section.side li ul {
+  display: inline;
+}
+
+.side ul {
+  padding:0;
+  margin:0 ;
+}
+
+.side img {
+  display: block;
+  margin-right: 1em;
+  margin-top: 1em;
+}
+
+section.main {
+  display: block;
+  padding-top:20px;
+}
+
+@media only screen and (min-width: 240px) {
+  .side img {
+    float:left;
+    margin: 0 1em 0 0;
+  }
+}
+
+@media only screen and (min-width: 800px) {
+  html {
+    width:600px;
+    padding:0 0 0 200px;
+  }
+  section.side {
+    width: 200px;
+    position: fixed;
+    margin: 0 0 0 -200px;
+  }
+  .side img {
+    display: block;
+    float:none;
+  }
+
+  section.side ul {
+    overflow: none;
+    display: block;
+  }
+
+  section.side li {
+    display: block;
+  }
+
+  section.side a {
+    display: block;
+  }
+
+  section.side li ul {
+    margin: 0;
+    display: block;
+  }
+
+  section.side li li {
+    margin-left: 1em;
+  }
+
+  .side h2, .side p {
+    margin-top: 1em;
+  }
+
+  section.main {
+    float: right;
+    width: 600px;
+    padding-bottom: 100px;
+  }
+}
+</style>
+<link href="/static/prism.css" rel="stylesheet">
+
+<body>
+
+<section class='side'>
+  <h2><a href=/><img src='/static/tapjs.png' width=100 height=100 alt='Test Anything JS'></a></h2>
+  <p>{{ site.description }}</p>
+  <ul>
+  {% for link in site.links %}
+    <li>
+      <a href="{{ link.url }}">{{ link.name }}</a>
+      {% if link.links %}
+      <ul>
+        {% for sublink in link.links %}
+        <li><a href="{{ sublink.url }}">{{ sublink.name }}</a></li>
+        {% endfor %}
+      </ul>
+      {% endif %}
+    </li>
+  {% endfor %}
+  </ul>
+  <pre><a href="http://npm.im/tap">npm install tap</a>
+<a href="/cli/">tap test/*.js</a></pre>
+</section>
+<section class='main'>
+{{ content }}
+</section>
+<script src="/static/prism.js"></script>
+</body>