npm - docgen-tool - Versions diffs - 2.1.3 → 3.0.1 - Mend

docgen-tool 2.1.3 → 3.0.1

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 (113) hide show

package/docs/release-notes.html DELETED Viewed

@@ -1,148 +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.3)</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">Release notes</h1><ul class="dg-pageToc"><li><a href="#docgen-2.1.3-released-29/05/2015">DocGen 2.1.3 released 29/05/2015</a></li><li><a href="#docgen-2.1.2-released-28/05/2015">DocGen 2.1.2 released 28/05/2015</a></li><li><a href="#docgen-2.1.1-released-28/05/2015">DocGen 2.1.1 released 28/05/2015</a></li><li><a href="#docgen-2.1.0-released-27/05/2015">DocGen 2.1.0 released 27/05/2015</a></li><li><a href="#docgen-2.0.1-released-31/03/2015">DocGen 2.0.1 released 31/03/2015</a></li><li><a href="#docgen-2.0.0-released-31/03/2015">DocGen 2.0.0 released 31/03/2015</a></li><li><a href="#docgen-1.0.1-released-18/01/2012">DocGen 1.0.1 released 18/01/2012</a></li><li><a href="#docgen-1.0.0-released-04/11/2011">DocGen 1.0.0 released 04/11/2011</a></li></ul><h2 id="docgen-2.1.3-released-29/05/2015">DocGen 2.1.3 released 29/05/2015</h2>
-<ul>
-<li>Allow more protocols in CommonMark links (see markdown-it <a href="https://github.com/markdown-it/markdown-it/issues/108">ticket #108</a>)</li>
-</ul>
-<h2 id="docgen-2.1.2-released-28/05/2015">DocGen 2.1.2 released 28/05/2015</h2>
-<ul>
-<li>Fixed a regression defect (exception when running docgen scaffold) that first appeared in DocGen 2.1.0</li>
-</ul>
-<h2 id="docgen-2.1.1-released-28/05/2015">DocGen 2.1.1 released 28/05/2015</h2>
-<ul>
-<li>Upgraded all node dependencies to the latest versions</li>
-<li>Upgraded styles to the latest release of Webknife (1.4.0)</li>
-</ul>
-<h2 id="docgen-2.1.0-released-27/05/2015">DocGen 2.1.0 released 27/05/2015</h2>
-<ul>
-<li>Added a command-line option for specifying a custom path to wkhtmltopdf</li>
-</ul>
-<h2 id="docgen-2.0.1-released-31/03/2015">DocGen 2.0.1 released 31/03/2015</h2>
-<ul>
-<li>Fixed the node package and user guide for installing with npm install -g</li>
-</ul>
-<h2 id="docgen-2.0.0-released-31/03/2015">DocGen 2.0.0 released 31/03/2015</h2>
-<ul>
-<li>DocGen is now open source</li>
-<li>Rewritten in JavaScript for Node.js</li>
-<li>Much easier to install (hosted on npm)</li>
-<li>Dependencies are now version controlled (using npm)</li>
-<li>Modernized visual style (uses Webknife CSS framework)</li>
-<li>Input metadata files are now in JSON rather than YAML format</li>
-<li>Top-level page headings are now inserted automatically (from contents.json)</li>
-<li>The web and PDF tables of contents both correspond to contents.json</li>
-<li>Command-line options are now used for configuration, rather than a config file</li>
-<li>Command-line output is now color coded (green success, red error)</li>
-<li>Added usage information to the command line interface</li>
-<li>Generating the PDF is now an optional feature</li>
-<li>Upgraded to the latest version of the PDF generator (wkhtmltopdf)</li>
-<li>Added support for mathematical expressions (with KaTex or MathJax)</li>
-<li>Added support for a list of document contributors (for multiple authors)</li>
-<li>Added support for a header link back to the application (integrated docs)</li>
-<li>Added time to the generation timestamp</li>
-<li>Renamed &apos;change log&apos; to &apos;release notes&apos;</li>
-<li>Fixed issues with fonts and text kerning in the PDF copy</li>
-<li>Fixed defect where unexpected text appeared on some pages with a page table of contents</li>
-<li>Dropped support for Internet Explorer 7 and 8</li>
-<li>Dropped formal support for tool to run on multiple operating systems</li>
-<li>Removed support for &apos;Mark of the Web&apos;</li>
-</ul>
-<h2 id="docgen-1.0.1-released-18/01/2012">DocGen 1.0.1 released 18/01/2012</h2>
-<ul>
-<li>Fixed a bug causing the table of contents headings to sometimes appear in the wrong order</li>
-</ul>
-<h2 id="docgen-1.0.0-released-04/11/2011">DocGen 1.0.0 released 04/11/2011</h2>
-<ul>
-<li>Ruby implementation (not released as open source)</li>
-<li>Creates a static website from Markdown input files</li>
-<li>Also creates a PDF copy using wkhtmltopdf</li>
-</ul>
-</div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.3 released on 29/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.3 on 29/05/2015 at 13:57:42.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>

package/docs/require/docgen.css DELETED Viewed

@@ -1,131 +0,0 @@
-pre {
-	font-size: 12px; /*todo - move to webknife*/
-}
-section blockquote p, section li p {
-	margin: 0;
-}
-.w-table {
-	width: 100%;
-}
-/******************************** TABLE OF CONTENTS ****************************/
-/*Table of contents button to initiate show/hide*/
-#dg-navigator
-{
- float: right;
- background-color: #4d4d4d;
- color: white;
- text-align:right;
- padding: 10px 20px 10px 20px;
- margin-right: 200px;
- border-radius: 0 0 10px 10px;
- cursor: pointer;
- font-weight: bold;
-}
-/*Table of contents container*/
-#dg-toc {
-	color: white;
-	background-color: #4d4d4d;
-}
-#dg-toc table {
-	table-layout: auto;
-	width: 100%;
-}
-#dg-toc div {
-	padding: 15px 0 15px 0;
-}
-/*Columns in table of contents*/
-#dg-toc td {
-	border-right: 1px solid #666;
-	vertical-align: top;
-	text-align: left;
-	padding: 0 20px 0 20px;
-}
-#dg-toc ul {
-	padding: 0;
-	list-style-type: none;
-}
-#dg-toc li {
-	font-weight: bold;
-}
-#dg-toc table td a {
-	color: white;
-	font-weight: normal;
-	text-decoration: none;
-	margin-left: 10px;
-}
-#dg-toc table td a:hover {
-	text-decoration: underline;
-}
-#dg-tocFixedColumn {
-	border-right: none;
-}
-#dg-toc table #dg-tocFixedColumn a {
-	vertical-align: middle;
-	margin-left: 4px;
-}
-.dg-tocGroup {
-	width: 22%;
-}
-.dg-tocHeading {
-	font-size: 16px;
-}
-.dg-tocIcon {width: 18px; height: 18px; float: left;}
-.dg-tocIcon svg {fill: white;}
-/*
-	Page table of contents
-*/
-.dg-pageToc {
-	list-style: none;
-	padding: 10px;
-	border: 1px solid #999;
-	background-color: #eee;
-}
-/*
-	Class to make a heading look invisible in web page, but still appear in the PDF table of contents
-		- display:none, visibily: hidden, zero dimensions, and offscreen positioning don't work
-		- so instead take it out of the flow and make it small and translucent
-*/
-.dg-hiddenTitle {
-	display: block;
-	border: none;
-	margin: 0;
-	padding: 0;
-	width: 1px;
-	height: 1px;
-	overflow: hidden;
-	position: absolute;
-	background-color: transparent;
-}
-.dg-fakeHeading { /*todo - move to webknife*/
-	text-decoration:none;
-	font-weight: bold;
-	color: #385691;
-	padding-bottom: 5px;
-	border-bottom: 1px solid #999;
-	margin: 20px 0 20px 0;
-	font-size: 16px;
-	padding-bottom: 4px;
-}

package/docs/require/katexInjector.js DELETED Viewed

@@ -1,22 +0,0 @@
-$(document).ready( function () {
-  //mathematical expressions using katex, if enabled
-  $('.dg-katexMath').each(function() {
-    var texTxt = $(this).text();
-    el = $(this).get(0);
-    if(el.tagName == "DIV"){
-        addDisp = "\\displaystyle";
-    } else {
-        addDisp = "";
-    }
-    try {
-        katex.render(addDisp+texTxt, el);
-    }
-    catch(err) {
-        $(this).html("<span class='err'>"+err);
-    }
-  });
-});

package/docs/require/print.css DELETED Viewed

@@ -1,19 +0,0 @@
-html {
- background-color :white; /*otherwise background artefacts appear as a feint outline in PDF*/
-}
-.dg-pageToc {
-	display: none;
-}
-#dg-toc, #dg-navigator, header, footer {
-	display: none;
-}
-.dg-avoidBreak, #dg-content th, #dg-content tr, #dg-content blockquote, #dg-content pre {
-	page-break-inside: avoid;
-}
-.dg-forceBreak {
-	page-break-after: always;
-}

package/docs/running.html DELETED Viewed

@@ -1,123 +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.3)</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">Running DocGen</h1><ul class="dg-pageToc"><li><a href="#overview">Overview</a></li><li><a href="#command-line-usage">Command-line usage</a></li><li><a href="#scaffold-command">Scaffold command</a></li><li><a href="#run-command">Run command</a></li></ul><h2 id="overview">Overview</h2>
-<p>DocGen is a command-line tool which takes plain text input files and outputs a static website.</p>
-<h2 id="command-line-usage">Command-line usage</h2>
-<p>The DocGen command-line interface includes usage help for both the tool and its subcommands:</p>
-<pre><code>docgen --help
-docgen run --help
-</code></pre>
-<h2 id="scaffold-command">Scaffold command</h2>
-<p>The <strong>scaffold</strong> command creates an <em>example</em> input directory. It outputs the minumum files required by DocGen, which
-can then be used as a template for making any new website.</p>
-<p><strong>Create a scaffold template in the working directory</strong> (./)<strong>:</strong></p>
-<pre><code>docgen scaffold
-</code></pre>
-<p><strong>Create a scaffold template in a specified directory:</strong></p>
-<pre><code>docgen scaffold -o $HOME/docgen-example
-</code></pre>
-<h2 id="run-command">Run command</h2>
-<p>The <strong>run</strong> command transforms an input directory (plain text source) into an output directory (HTML+PDF).</p>
-<p><strong>Basic usage:</strong></p>
-<pre><code>docgen run -i $HOME/docgen-example -o $HOME/docgen-output
-</code></pre>
-<p><strong>Optionally create a PDF:</strong></p>
-<pre><code>docgen run -i $HOME/docgen-example -o $HOME/docgen-output -p
-</code></pre>
-<p><strong>Optionally create a redirect page:</strong></p>
-<pre><code>docgen run -i $HOME/docgen-example -o $HOME/docgen-output -r
-</code></pre>
-<blockquote>
-<p>The optional redirect page is an &apos;index.html&apos; file that is placed in the output&apos;s parent directory. The redirect page
-redirects the user to the homepage in the output directory. This is mostly useful for hosting the website without having
-to place all the files in the root directory.</p>
-</blockquote>
-</div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.3 released on 29/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.3 on 29/05/2015 at 13:57:42.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>

package/docs/troubleshooting.html DELETED Viewed

@@ -1,105 +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.3)</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">Troubleshooting</h1><ul class="dg-pageToc"><li><a href="#displaying-detailed-errors">Displaying detailed errors</a></li><li><a href="#pdf-missing-content">PDF missing content</a></li><li><a href="#attached-files-not-in-pdf">Attached files not in PDF</a></li><li><a href="#corrupted-text-characters">Corrupted text characters</a></li><li><a href="#missing-logo">Missing logo</a></li><li><a href="#other-issues">Other issues</a></li></ul><p>This section gives help on solving common issues with DocGen.</p>
-<h2 id="displaying-detailed-errors">Displaying detailed errors</h2>
-<p>Pass the <strong>-v</strong> (verbose) option when running DocGen to get more detailed error messages.</p>
-<h2 id="pdf-missing-content">PDF missing content</h2>
-<p>In complex pages, the PDF generator (wkhtmltopdf) needs to be given enough time for dynamic content to be rendered.
-Pass the <strong>-d [milliseconds]</strong> option to increase the rendering time for each page, if required.</p>
-<h2 id="attached-files-not-in-pdf">Attached files not in PDF</h2>
-<p>Attached files are not converted to PDF, only the web content is.</p>
-<h2 id="corrupted-text-characters">Corrupted text characters</h2>
-<p>Make sure all the input text files are saved with UTF-8 encoding.</p>
-<h2 id="missing-logo">Missing logo</h2>
-<p>The logo must be PNG format and saved with the path <em>files/images/logo.png</em>.</p>
-<h2 id="other-issues">Other issues</h2>
-<p>For any other problems, please submit a <a href="https://github.com/mtmacdonald/docgen/issues">an issue ticket</a>.</p>
-</div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.3 released on 29/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.3 on 29/05/2015 at 13:57:42.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>