npm - docgen-tool - Versions diffs - 2.1.2 → 3.0.0 - Mend

docgen-tool 2.1.2 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (81) hide show

package/.gitattributes +1 -0
package/.github/workflows/deploy-website.yml +28 -0
package/.prettierignore +4 -0
package/.prettierrc +4 -0
package/LICENSE +35 -33
package/{docgen → dist/docgen.js} +11 -22
package/docgen.js +95 -0
package/package.json +47 -20
package/source/__test__/test-run/contents.json +12 -0
package/source/__test__/test-run/overview.txt +3 -0
package/source/__test__/test-run/parameters.json +32 -0
package/source/__test__/test-run/release-notes.txt +4 -0
package/source/docgen.js +900 -775
package/source/example/contents.json +11 -11
package/source/example/index.txt +3 -3
package/source/example/parameters.json +36 -36
package/source/internal-readme.md +4 -0
package/source/pdf-stylesheet.css +26 -20
package/source/require/docgen.css +76 -69
package/source/require/katexInjector.js +9 -13
package/source/require/print.css +26 -19
package/source/templates/main.html +93 -93
package/source/user-guide/advanced-content.txt +170 -170
package/source/user-guide/contents.json +56 -56
package/source/user-guide/files/images/svg/inkit-logo.svg +9 -0
package/source/user-guide/index.txt +257 -244
package/source/user-guide/installation.txt +49 -49
package/source/user-guide/parameters.json +36 -36
package/source/user-guide/release-notes.txt +69 -58
package/source/user-guide/running.txt +46 -46
package/source/user-guide/troubleshooting.txt +31 -31
package/source/user-guide/upgrading.txt +25 -25
package/source/user-guide/version-control.txt +13 -13
package/source/user-guide/writing-content.txt +269 -269
package/tsconfig.json +8 -0
package/.npmignore +0 -2
package/docs/advanced-content.html +0 -239
package/docs/commonmark.html +0 -225
package/docs/docgen.pdf +0 -0
package/docs/files/images/overview.png +0 -0
package/docs/files/images/pdf.png +0 -0
package/docs/files/images/svg/icon.svg +0 -845
package/docs/files/images/svg/overview.svg +0 -1345
package/docs/files/images/text.png +0 -0
package/docs/files/images/web.png +0 -0
package/docs/index.html +0 -333
package/docs/installation.html +0 -121
package/docs/ownership.html +0 -164
package/docs/release-notes.html +0 -144
package/docs/require/docgen.css +0 -131
package/docs/require/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Main-Bold.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Main-Italic.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Main-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Math-Italic.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Math-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
package/docs/require/katex/katex.min.css +0 -1
package/docs/require/katex/katex.min.js +0 -6
package/docs/require/katexInjector.js +0 -22
package/docs/require/print.css +0 -19
package/docs/require/webknife/fonts/DroidSansMono.woff +0 -0
package/docs/require/webknife/fonts/OpenSans.woff +0 -0
package/docs/require/webknife/fonts/OpenSansBold.woff +0 -0
package/docs/require/webknife/fonts/OpenSansBoldItalic.woff +0 -0
package/docs/require/webknife/fonts/OpenSansItalic.woff +0 -0
package/docs/require/webknife/framework.icons.js +0 -82
package/docs/require/webknife/framework.min.css +0 -3
package/docs/require/webknife/framework.min.js +0 -14
package/docs/require/webknife/highlight.min.css +0 -1
package/docs/require/webknife/highlight.min.js +0 -6
package/docs/running.html +0 -123
package/docs/troubleshooting.html +0 -105
package/docs/upgrading.html +0 -124
package/docs/version-control.html +0 -102
package/docs/writing-content.html +0 -305
/package/{docs → source/__test__/test-run}/files/images/logo.png +0 -0

package/docs/files/images/text.png DELETED Viewed

Binary file

package/docs/files/images/web.png DELETED Viewed

Binary file

package/docs/index.html DELETED Viewed

@@ -1,333 +0,0 @@
-<!doctype html>
-<html>
- <head>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge"><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
-  <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
-  <meta charset="UTF-8">
-  <title>DocGen - a documentation tool</title>
-  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
-  <link rel="stylesheet" href="require/webknife/framework.min.css" type="text/css">
-  <link rel="stylesheet" href="require/webknife/highlight.min.css" type="text/css">
-  <link rel="stylesheet" href="require/docgen.css" type="text/css">
-  <link rel="stylesheet" href="require/print.css" media="print">
-  <!--load scripts second-->
-  <script src="require/webknife/framework.min.js"></script>
-  <script src="require/webknife/framework.icons.js"></script>
-  <script src="require/webknife/highlight.min.js"></script>
-  <!--inline scripts last-->
-<script type="text/javascript">
-$(document).ready( function () {
-  $("#dg-toc").hide(); //hide the table of contents
-  //instantiate an svg injector to show SVG icons
-  var injector = new svgInject();
-  injector.inject();
-  //code syntax highlighting
-  $('pre code, .w-inline-code').each(function(i, block) {
-    hljs.highlightBlock(block);
-  });
-  //toggle visibility of table of contents
-  $("#dg-navigator").click(function()
-  {
-    $("#dg-toc").slideToggle("fast");
-    $(this).toggleClass("active");
-  });
-});
-</script>
-<script type="text/x-mathjax-config">
-//MathJax configuration is the same as used by math.stackexchange.com
-MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX","TeX"], linebreaks: { automatic:true }, EqnChunk: (MathJax.Hub.Browser.isMobile ? 10 : 50) },
-  tex2jax: { inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], processEscapes: true, ignoreClass: "tex2jax_ignore|dno" },
-  TeX: {  noUndefined: { attributes: { mathcolor: "red", mathbackground: "#FFEEEE", mathsize: "90%" } }, Macros: { href: "{}" } },
-  messageStyle: "none"
-});
-</script>
-<link rel="stylesheet" href="require/katex/katex.min.css" type="text/css"><script type="text/javascript" src="require/katex/katex.min.js"></script><script type="text/javascript" src="require/katexInjector.js"></script><script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full"></script></head>
-<body>
-<div id="dg-toc"><div><table class="unstyled"><tr><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Quick Start</li><li><a href="index.html">Overview</a></li><li><a href="installation.html">Installation</a></li><li><a href="upgrading.html">Upgrading</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">User Guide</li><li><a href="running.html">Running DocGen</a></li><li><a href="writing-content.html">Writing content</a></li><li><a href="commonmark.html">CommonMark reference</a></li><li><a href="advanced-content.html">Advanced content</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Help</li><li><a href="troubleshooting.html">Troubleshooting</a></li><li><a href="version-control.html">Using with version control</a></li></ul></td><td class="dg-tocGroup"></td><td class="dg-tocGroup" id="dg-tocFixedColumn"><ul><li><span class="w-icon dg-tocIcon" data-name="person_group" title="archive"></span><a href="ownership.html">Ownership</a></li><li><span class="w-icon dg-tocIcon" data-name="refresh" title="archive"></span><a href="release-notes.html">Release Notes</a></li></ul><div><button class="w-icon-button" onclick="window.location=&apos;docgen.pdf&apos;;"><span class="w-icon" data-name="document"></span><span>PDF copy</span></button></div></td></tr></table></div></div>
-<div id="dg-navigator">Table of contents</div>
-<header>
- <div class="w-fixed-width">
-  <a id="dg-homelink" href="index.html">
-    <div id="dg-logo" style="background-image: url(files/images/logo.png); height: 42px; line-height: 42px; padding-left: 85px;">
-      <span id="dg-title">DocGen - a documentation tool</span> <span id="dg-web-title-version" style="font-weight:normal;">(2.1.2)</span>
-    </div>
-  </a>
-  <div>
-    <span id="dg-backlink"></span>
-  </div>
- </div>
-</header>
-<section id="dg-content"><div id="dg-innerContent"><h1 id="dg-autoTitle" class="dg-hiddenTitle">Overview</h1><style>
-#dg-content, #dg-innerContent {
-  padding-top: 0;
-}
-#banner, #banner-buttons {
-  margin: 0;
-}
-#banner {
-  color: #385691;
-  font-weight: bold;
-  padding-top: 30px;
-  background-color: #f7f7f7;
-  box-shadow: inset 0px 5px 5px 0px #e7e7e7;
-}
-#banner img {
-  padding: 25px 0 25px 0;
-}
-#banner-buttons {
-  background-color: #f7f7f7;
-  padding: 20px 0 20px 0;
-  background-color: #999;
-}
-.spaced {
-  margin-right: 15px;
-}
-.heading-text {
-  font-size: 16px;
-  text-align: center;
-}
-.segment {
-  border-bottom: 2px solid #4d4d4d;
-  padding: 20px 0 20px 0;
-}
-.how-it-works li {
-  vertical-align: top;
-  display: inline-block;
-  width: 290px;
-  margin: 10px;
-  padding: 0;
-  border: 2px solid #4d4d4d;
-  border-radius: 10px 10px 0 0;
-}
-.how-it-works li p:first-of-type {
-  margin: 0;
-  border: none;
-  background-color: #4d4d4d;
-  color: white;
-  padding: 18px 10px 18px 10px;
-  text-align: center;
-  font-style: italic;
-  font-weight: bold;
-  border-radius: 7px 7px 0 0;
-}
-.how-it-works li p:first-of-type a {
-  color: white;
-}
-.how-it-works li p:last-of-type {
-  padding:0;
-  margin:0;
-  height: 400px;
-  background-repeat:no-repeat;
-}
-.features {
-  margin: 0;
-  padding: 0;
-  width: 100%;
-}
-.features li {
-  vertical-align: top;
-  display: inline-block;
-  width: 220px;
-  margin: 10px;
-}
-.features li span {
-  vertical-align: middle;
-  margin-right: 5px;
-}
-.features li p:first-of-type {
-  margin: 0;
-  padding: 0 0 3px 0;
-  font-size: 14px;
-  font-weight: bold;
-  color: #385691;
-  border: none;
-}
-.features li p:last-of-type {
-  padding-top: 5px;
-  margin: 0;
-}
-</style>
-<div id="banner" class="segment"><div class="w-fixed-width">
-  <p class="w-massive w-center w-no-underline">Better documentation for software products.</p>
-  <img class="w-center" src="files/images/overview.png" alt="overview">
-</div></div>
-<div id="banner-buttons" class="segment"><div class="w-fixed-width">
-  <span class="w-center">
-  <a href="https://github.com/mtmacdonald/docgen/releases" class="w-button-link w-colored w-large spaced">Download</a>
-  <a href="https://github.com/mtmacdonald/docgen/issues" class="w-button-link w-dark">Report Issues</a>
-  </span>
-</div></div>
-<div class="segment" style="border-bottom: none; margin-bottom:0; padding-bottom:0;"><div class="w-fixed-width">
-<p class="heading-text">
- <strong>DocGen</strong> is a <strong>static website generator</strong> that&apos;s ideal for making technical user guides for software products.
-</p>
-<h2 class="dg-hiddenTitle" id="features">Features</h2>
-<ul class="features">
-<li>
-  <p><span class="w-icon" data-name="monitor"></span><span>Self-contained website</span></p>
-  <p>Creates a static website that works on any server, or as local files (CD, shared drive etc).</p>
-</li>
-<li>
-  <p><span class="w-icon" data-name="document"></span><span>Optional PDF</span></p>
-  <p>Also publishes the website content as a single PDF, using <a href="http://wkhtmltopdf.org">wkhtmltopdf</a>.</p>
-</li>
-<li>
-  <p><span class="w-icon" data-name="edit"></span><span>Human-friendly input</span></p>
-  <p>Write in plain text, or the human-friendly <a href="http://commonmark.org">CommonMark</a> format
-  (Markdown).</p>
-</li>
-<li>
-  <p><span class="w-icon" data-name="gear_a"></span><span>Easy to version control</span></p>
-  <p>Easily version control software documentation in sync with its product.</p>
-</li>
-<li>
-  <p><span class="w-icon" data-name="clipboard"></span><span>Table of contents</span></p>
-  <p>Automatically creates tables of contents, with links and PDF page numbers.</p>
-</li>
-<li>
-  <p><span class="w-icon" data-name="code"></span><span>Code syntax highlighting</span></p>
-  <p>Automatically highlights code blocks, using <a href="https://highlightjs.org">Highlight.js</a>, with language detection.</p>
-</li>
-<li>
-  <p><span class="w-icon" data-name="compose"></span><span>Mathematical expressions</span></p>
-  <p>Displays mathematical expressions without plugins, using either
-  <a href="http://khan.github.io/KaTeX/">KaTeX</a> or
-  <a href="https://www.mathjax.org">MathJax</a>.</p>
-</li>
-<li>
-  <p><span class="w-icon" data-name="star"></span><span>Branding and metadata</span></p>
-  <p>Easily brand with a logo, attribute ownership, and attach release notes.</p>
-</li>
-</ul>
-<p class="heading-text">DocGen makes it easy for anyone to create high-quality technical documentation.</p>
-</div></div>
-<div style="padding-top:20px;"><div class="w-fixed-width">
-<p class="dg-forceBreak"></p>
-<h2 id="how-it-works">How it works</h2>
-<ul class="how-it-works" id="how-it-works">
-<li>
-  <p>&quot;You write in plain text or human-friendly <a href="http://commonmark.org">CommonMark</a>&quot;</p>
-  <p style="background-image:url(&apos;files/images/text.png&apos;);"></p>
-</li>
-<li>
-  <p>&quot;DocGen styles and publishes all your content as a website&quot;</p>
-  <p style="background-image:url(&apos;files/images/web.png&apos;);"></p>
-</li>
-<li>
-  <p>&quot;DocGen also creates an equivalent PDF copy&quot;</p>
-  <p style="background-image:url(&apos;files/images/pdf.png&apos;);"></p>
-</li>
-</ul>
-<table style="width:600px; border:none; padding:0;" class="w-table w-fixed w-stripe">
- <tr style="border:none; padding:0;">
-  <td style="border:none; text-align:left; padding:0; vertical-align: top;"><ul>
-   <li class="list-heading">Flexible Input Formats</li>
-   <li>Plain text</li>
-   <li>CommonMark (Markdown)</li>
-   <li>HTML</li>
-   <li>LaTeX mathematical expressions</li>
-   <li>Image diagrams</li>
-   <li>Attach other documents</li>
-  </ul></td>
-  <td style="border:none; text-align:left; padding:0; vertical-align: top;"><ul>
-   <li class="list-heading">Configurable Metadata</li>
-   <li>Branding (logo, title, organization)</li>
-   <li>License, copyright, and legal markings</li>
-   <li>Ownership and attribution</li>
-   <li>Version information</li>
-   <li>Release notes (change log)</li>
-  </ul></td>
- </tr>
-</table>
-<blockquote>
-DocGen is probably not the right tool for precision PDF layout. Or for product configurators which need to output
-variants based on a common template. Docgen is intended more for free-form, human generated content which is regularly
-updated and refactored, and standardised for each product release.
-</blockquote>
-<h2 id="browser-support">Browser support</h2>
-Output created by DocGen works in modern browsers (desktop and mobile devices).
-<ul><li>tested in <a href="http://windows.microsoft.com/en-us/internet-explorer/download-ie">Internet Explorer 9+</a>,
-<a href="http://www.google.com/chrome">Chrome</a>,
-<a href="https://www.mozilla.org/en-US/firefox/new">Firefox</a>,
-<a href="https://www.apple.com/safari">Safari</a></li></ul>
-<h2 id="quick-start">Quick start</h2>
-<ul>
- <li class="list-heading">In just three commands:</li>
- <li>Install DocGen</li>
- <li>Scaffold an empty template</li>
- <li>Generate a static website</li>
-</ul>Enter these commands in the terminal:<p></p>
-<pre><code>sudo npm install -g docgen-tool
-docgen scaffold
-docgen run -o $HOME/docgen-example</code></pre>
-<p>See the <a href="installation.html">installation guide</a> for more detailed instructions.</p>
-</div></div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.2 released on 28/05/2015.</span></p></div>
-  <div class="w-fixed-width">
-    <p><span id="dg-copyright">&#xA9; 2015 <a href="https://github.com/mtmacdonald">Mark Macdonald</a></span></p>
-    <p>
-      <span id="dg-marking">MIT License.</span>
-      <span id="dg-legalese"></span>
-      <span id="dg-attribution">Created by DocGen 2.1.2 on 28/05/2015 at 18:31:56.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>

package/docs/installation.html DELETED Viewed

@@ -1,121 +0,0 @@
-<!doctype html>
-<html>
- <head>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge"><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
-  <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
-  <meta charset="UTF-8">
-  <title>DocGen - a documentation tool</title>
-  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
-  <link rel="stylesheet" href="require/webknife/framework.min.css" type="text/css">
-  <link rel="stylesheet" href="require/webknife/highlight.min.css" type="text/css">
-  <link rel="stylesheet" href="require/docgen.css" type="text/css">
-  <link rel="stylesheet" href="require/print.css" media="print">
-  <!--load scripts second-->
-  <script src="require/webknife/framework.min.js"></script>
-  <script src="require/webknife/framework.icons.js"></script>
-  <script src="require/webknife/highlight.min.js"></script>
-  <!--inline scripts last-->
-<script type="text/javascript">
-$(document).ready( function () {
-  $("#dg-toc").hide(); //hide the table of contents
-  //instantiate an svg injector to show SVG icons
-  var injector = new svgInject();
-  injector.inject();
-  //code syntax highlighting
-  $('pre code, .w-inline-code').each(function(i, block) {
-    hljs.highlightBlock(block);
-  });
-  //toggle visibility of table of contents
-  $("#dg-navigator").click(function()
-  {
-    $("#dg-toc").slideToggle("fast");
-    $(this).toggleClass("active");
-  });
-});
-</script>
-<script type="text/x-mathjax-config">
-//MathJax configuration is the same as used by math.stackexchange.com
-MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX","TeX"], linebreaks: { automatic:true }, EqnChunk: (MathJax.Hub.Browser.isMobile ? 10 : 50) },
-  tex2jax: { inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], processEscapes: true, ignoreClass: "tex2jax_ignore|dno" },
-  TeX: {  noUndefined: { attributes: { mathcolor: "red", mathbackground: "#FFEEEE", mathsize: "90%" } }, Macros: { href: "{}" } },
-  messageStyle: "none"
-});
-</script>
-<link rel="stylesheet" href="require/katex/katex.min.css" type="text/css"><script type="text/javascript" src="require/katex/katex.min.js"></script><script type="text/javascript" src="require/katexInjector.js"></script><script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full"></script></head>
-<body>
-<div id="dg-toc"><div><table class="unstyled"><tr><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Quick Start</li><li><a href="index.html">Overview</a></li><li><a href="installation.html">Installation</a></li><li><a href="upgrading.html">Upgrading</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">User Guide</li><li><a href="running.html">Running DocGen</a></li><li><a href="writing-content.html">Writing content</a></li><li><a href="commonmark.html">CommonMark reference</a></li><li><a href="advanced-content.html">Advanced content</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Help</li><li><a href="troubleshooting.html">Troubleshooting</a></li><li><a href="version-control.html">Using with version control</a></li></ul></td><td class="dg-tocGroup"></td><td class="dg-tocGroup" id="dg-tocFixedColumn"><ul><li><span class="w-icon dg-tocIcon" data-name="person_group" title="archive"></span><a href="ownership.html">Ownership</a></li><li><span class="w-icon dg-tocIcon" data-name="refresh" title="archive"></span><a href="release-notes.html">Release Notes</a></li></ul><div><button class="w-icon-button" onclick="window.location=&apos;docgen.pdf&apos;;"><span class="w-icon" data-name="document"></span><span>PDF copy</span></button></div></td></tr></table></div></div>
-<div id="dg-navigator">Table of contents</div>
-<header>
- <div class="w-fixed-width">
-  <a id="dg-homelink" href="index.html">
-    <div id="dg-logo" style="background-image: url(files/images/logo.png); height: 42px; line-height: 42px; padding-left: 85px;">
-      <span id="dg-title">DocGen - a documentation tool</span> <span id="dg-web-title-version" style="font-weight:normal;">(2.1.2)</span>
-    </div>
-  </a>
-  <div>
-    <span id="dg-backlink"></span>
-  </div>
- </div>
-</header>
-<section id="dg-content"><div class="w-fixed-width"><div id="dg-innerContent"><h1 id="dg-autoTitle">Installation</h1><ul class="dg-pageToc"><li><a href="#supported-platform">Supported platform</a></li><li><a href="#dependencies">Dependencies</a></li><li><a href="#optional-dependencies-(only-for-pdf)">Optional dependencies (only for PDF)</a></li><li><a href="#quick-install-with-npm">Quick install with NPM</a></li><li><a href="#install-by-direct-download">Install by direct download</a></li></ul><p>This section explains how to install DocGen.</p>
-<h2 id="supported-platform">Supported platform</h2>
-<p><em>&apos;Supported platform&apos;</em> means the software required to <strong>run</strong> the DocGen tool. The static website <strong>produced</strong> by
-DocGen will work on all modern browsers on all all major operating systems
-(see <a href="index.html#browser-support">browser support</a>).</p>
-<p class="w-information">
-    The supported platform for this version of DocGen is:
-    <strong>Ubuntu 14.04</strong> with <strong>Node.js 0.12.0</strong>
-    and <strong>wkhtmltopdf 0.12.2.1 </strong>(with patched qt).
-</p>
-<p>While other operating systems and dependency versions may work, they are not tested or officially supported.</p>
-<h2 id="dependencies">Dependencies</h2>
-<p>DocGen requires <strong><a href="https://nodejs.org">Node.js</a></strong>. To install on Ubuntu Linux, enter these terminal commands:</p>
-<pre><code>curl -sL https://deb.nodesource.com/setup_0.12 | sudo bash -
-sudo apt-get install -y nodejs
-</code></pre>
-<p>This method uses the
-<a href="https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories">NodeSource Linux Repositories</a>
-(recommended).</p>
-<p>For other platforms (not supported), see the <a href="https://nodejs.org/download">download page</a> or vendor instructions.</p>
-<h2 id="optional-dependencies-(only-for-pdf)">Optional dependencies (only for PDF)</h2>
-<p>For optional PDF support, DocGen requires <strong><a href="http://wkhtmltopdf.org">wkhtmltopdf</a></strong>. See the wkthmltopdf website for
-installation instructions.</p>
-<h2 id="quick-install-with-npm">Quick install with NPM</h2>
-<p>The quickest way to install DocGen is with <strong><a href="https://www.npmjs.com">npm</a></strong> (the JavaScript package manager). Enter
-these terminal commands:</p>
-<pre><code>sudo npm install -g docgen-tool
-</code></pre>
-<h2 id="install-by-direct-download">Install by direct download</h2>
-<p>DocGen can also be installed by <a href="https://github.com/mtmacdonald/docgen">direct download</a>.</p>
-</div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.2 released on 28/05/2015.</span></p></div>
-  <div class="w-fixed-width">
-    <p><span id="dg-copyright">&#xA9; 2015 <a href="https://github.com/mtmacdonald">Mark Macdonald</a></span></p>
-    <p>
-      <span id="dg-marking">MIT License.</span>
-      <span id="dg-legalese"></span>
-      <span id="dg-attribution">Created by DocGen 2.1.2 on 28/05/2015 at 18:31:56.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>

package/docs/ownership.html DELETED Viewed

@@ -1,164 +0,0 @@
-<!doctype html>
-<html>
- <head>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge"><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
-  <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
-  <meta charset="UTF-8">
-  <title>DocGen - a documentation tool</title>
-  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
-  <link rel="stylesheet" href="require/webknife/framework.min.css" type="text/css">
-  <link rel="stylesheet" href="require/webknife/highlight.min.css" type="text/css">
-  <link rel="stylesheet" href="require/docgen.css" type="text/css">
-  <link rel="stylesheet" href="require/print.css" media="print">
-  <!--load scripts second-->
-  <script src="require/webknife/framework.min.js"></script>
-  <script src="require/webknife/framework.icons.js"></script>
-  <script src="require/webknife/highlight.min.js"></script>
-  <!--inline scripts last-->
-<script type="text/javascript">
-$(document).ready( function () {
-  $("#dg-toc").hide(); //hide the table of contents
-  //instantiate an svg injector to show SVG icons
-  var injector = new svgInject();
-  injector.inject();
-  //code syntax highlighting
-  $('pre code, .w-inline-code').each(function(i, block) {
-    hljs.highlightBlock(block);
-  });
-  //toggle visibility of table of contents
-  $("#dg-navigator").click(function()
-  {
-    $("#dg-toc").slideToggle("fast");
-    $(this).toggleClass("active");
-  });
-});
-</script>
-<script type="text/x-mathjax-config">
-//MathJax configuration is the same as used by math.stackexchange.com
-MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX","TeX"], linebreaks: { automatic:true }, EqnChunk: (MathJax.Hub.Browser.isMobile ? 10 : 50) },
-  tex2jax: { inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], processEscapes: true, ignoreClass: "tex2jax_ignore|dno" },
-  TeX: {  noUndefined: { attributes: { mathcolor: "red", mathbackground: "#FFEEEE", mathsize: "90%" } }, Macros: { href: "{}" } },
-  messageStyle: "none"
-});
-</script>
-<link rel="stylesheet" href="require/katex/katex.min.css" type="text/css"><script type="text/javascript" src="require/katex/katex.min.js"></script><script type="text/javascript" src="require/katexInjector.js"></script><script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full"></script></head>
-<body>
-<div id="dg-toc"><div><table class="unstyled"><tr><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Quick Start</li><li><a href="index.html">Overview</a></li><li><a href="installation.html">Installation</a></li><li><a href="upgrading.html">Upgrading</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">User Guide</li><li><a href="running.html">Running DocGen</a></li><li><a href="writing-content.html">Writing content</a></li><li><a href="commonmark.html">CommonMark reference</a></li><li><a href="advanced-content.html">Advanced content</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Help</li><li><a href="troubleshooting.html">Troubleshooting</a></li><li><a href="version-control.html">Using with version control</a></li></ul></td><td class="dg-tocGroup"></td><td class="dg-tocGroup" id="dg-tocFixedColumn"><ul><li><span class="w-icon dg-tocIcon" data-name="person_group" title="archive"></span><a href="ownership.html">Ownership</a></li><li><span class="w-icon dg-tocIcon" data-name="refresh" title="archive"></span><a href="release-notes.html">Release Notes</a></li></ul><div><button class="w-icon-button" onclick="window.location=&apos;docgen.pdf&apos;;"><span class="w-icon" data-name="document"></span><span>PDF copy</span></button></div></td></tr></table></div></div>
-<div id="dg-navigator">Table of contents</div>
-<header>
- <div class="w-fixed-width">
-  <a id="dg-homelink" href="index.html">
-    <div id="dg-logo" style="background-image: url(files/images/logo.png); height: 42px; line-height: 42px; padding-left: 85px;">
-      <span id="dg-title">DocGen - a documentation tool</span> <span id="dg-web-title-version" style="font-weight:normal;">(2.1.2)</span>
-    </div>
-  </a>
-  <div>
-    <span id="dg-backlink"></span>
-  </div>
- </div>
-</header>
-<section id="dg-content"><div class="w-fixed-width"><div id="dg-innerContent"><style>
-#dg-coverInfo {
-  margin-top: 100px;
-  margin-bottom: 50px;
-  width: 100%;
-}
-#dg-coverInfo {
-  border-collapse: separate; /*http://stackoverflow.com/questions/7625586/*/
-}
-#dg-coverInfo th {
-  background-color: #385691;
-  color: white;
-  font-size: 34px;
-  padding: 20px;
-  border: 1px solid #385691;
-  border-radius: 10px 10px 0 0;
-}
-#dg-coverInfo tr td {
-  border-top: 2px solid #385691;
-  border-left: 2px solid #385691;
-  border-bottom: none;
-  border-right: none;
-  padding-top: 20px;
-  padding-bottom: 20px;
-}
-#dg-coverInfo td:last-child {
-  border-right: 2px solid #385691;
-}
-#dg-coverInfo .dg-finalRow td {
-  border-bottom: 2px solid #385691;
-}
-#dg-summary {
-  margin-bottom: 100px;
-}
-</style>
-<table class="w-table w-fixed" id="dg-coverInfo">
-<thead>
- <tr>
-  <th colspan="3" id="dg-title">DocGen - a documentation tool</th>
- </tr>
- </thead>
- <tfoot>
- </tfoot>
- <tbody>
- <tr>
-  <td><strong>Owner: </strong> <span id="dg-owner"><a href="https://github.com/mtmacdonald">Mark Macdonald</a></span></td>
-  <td><strong>Version: </strong> <span id="dg-version">2.1.2</span></td>
-  <td><strong>Released: </strong> <span id="dg-release-date">28/05/2015</span></td>
- </tr>
- <tr>
-  <td><strong>Author: </strong> <span id="dg-author"><a href="https://github.com/mtmacdonald">Mark Macdonald</a></span></td>
-  <td colspan="2"><strong>Contributors: </strong> <span id="dg-contributors"></span></td>
- </tr>
- <tr class="dg-finalRow">
-  <td><strong>Module: </strong> <span id="dg-module"></span></td>
-  <td><strong>ID: </strong> <span id="dg-id"></span></td>
-  <td><strong>Link: </strong> <span id="dg-website"><a href="https://github.com/mtmacdonald/docgen">Github</a></span></td>
- </tr>
- <tr>
-</tr></tbody>
-</table>
-<h1>Summary</h1>
-<p id="dg-summary">DocGen is a command-line documentation tool for software products. It takes plain text or CommonMark (Markdown) as input, and generates both a static website and a PDF copy.</p>
-</div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.2 released on 28/05/2015.</span></p></div>
-  <div class="w-fixed-width">
-    <p><span id="dg-copyright">&#xA9; 2015 <a href="https://github.com/mtmacdonald">Mark Macdonald</a></span></p>
-    <p>
-      <span id="dg-marking">MIT License.</span>
-      <span id="dg-legalese"></span>
-      <span id="dg-attribution">Created by DocGen 2.1.2 on 28/05/2015 at 18:31:56.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>