docgen-tool 2.1.3 → 3.0.0

package/source/user-guide/index.txt

@@ -1,245 +1,258 @@
-<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'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>How it works</h2>
-
-<ul class="how-it-works" id="how-it-works">
-<li>
-  <p>"You write in plain text or human-friendly <a href="http://commonmark.org">CommonMark</a>"</p>
-  <p style="background-image:url('files/images/text.png');"></p>
-</li>
-<li>
-  <p>"DocGen styles and publishes all your content as a website"</p>
-  <p style="background-image:url('files/images/web.png');"></p>
-</li>
-<li>
-  <p>"DocGen also creates an equivalent PDF copy"</p>
-  <p style="background-image:url('files/images/pdf.png');"></p>
-</li>
-</ul>
-
-<table style="width:600px; border:none; padding:0;">
- <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 
-
-<p>Enter these commands in the terminal:</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>
-
+<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'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">
+
+<h2>Sponsors</h2>
+
+DocGen is open-source software sponsored by <a href="https://www.inkit.com">inkit.com</a>.
+
+<div class="w-center">
+    <a href="https://www.inkit.com">
+        <img
+            src="files/images/svg/inkit-logo.svg"
+            style="width: 180px"
+        />
+    </a>
+</div>
+
+<p class="dg-forceBreak"></p>
+<h2>How it works</h2>
+
+<ul class="how-it-works" id="how-it-works">
+<li>
+  <p>"You write in plain text or human-friendly <a href="http://commonmark.org">CommonMark</a>"</p>
+  <p style="background-image:url('files/images/text.png');"></p>
+</li>
+<li>
+  <p>"DocGen styles and publishes all your content as a website"</p>
+  <p style="background-image:url('files/images/web.png');"></p>
+</li>
+<li>
+  <p>"DocGen also creates an equivalent PDF copy"</p>
+  <p style="background-image:url('files/images/pdf.png');"></p>
+</li>
+</ul>
+
+<table style="width:600px; border:none; padding:0;">
+ <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 
+
+<p>Enter these commands in the terminal:</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>

package/source/user-guide/installation.txt

@@ -1,49 +1,49 @@
-This section explains how to install DocGen.
-
-Supported platform
-------------------
-
-*'Supported platform'* means the software required to **run** the DocGen tool. The static website **produced** by 
-DocGen will work on all modern browsers on all all major operating systems 
-(see [browser support](index.html#browser-support)).
-
-<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>
-
-While other operating systems and dependency versions may work, they are not tested or officially supported.
-
-Dependencies
-------------
-
-DocGen requires **[Node.js](https://nodejs.org)**. To install on Ubuntu Linux, enter these terminal commands:
-
-	curl -sL https://deb.nodesource.com/setup_0.12 | sudo bash -
-	sudo apt-get install -y nodejs
-
-This method uses the 
-[NodeSource Linux Repositories](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories)
-(recommended).
-
-For other platforms (not supported), see the [download page](https://nodejs.org/download) or vendor instructions.
-
-Optional dependencies (only for PDF)
-------------------------------------
-
-For optional PDF support, DocGen requires **[wkhtmltopdf](http://wkhtmltopdf.org)**. See the wkthmltopdf website for
-installation instructions.
-
-Quick install with NPM
-----------------------
-
-The quickest way to install DocGen is with **[npm](https://www.npmjs.com)** (the JavaScript package manager). Enter 
-these terminal commands:
-
-	sudo npm install -g docgen-tool
-
-Install by direct download
---------------------------
-
-DocGen can also be installed by [direct download](https://github.com/mtmacdonald/docgen).
+This section explains how to install DocGen.
+
+Supported platform
+------------------
+
+*'Supported platform'* means the software required to **run** the DocGen tool. The static website **produced** by 
+DocGen will work on all modern browsers on all all major operating systems 
+(see [browser support](index.html#browser-support)).
+
+<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>
+
+While other operating systems and dependency versions may work, they are not tested or officially supported.
+
+Dependencies
+------------
+
+DocGen requires **[Node.js](https://nodejs.org)**. To install on Ubuntu Linux, enter these terminal commands:
+
+	curl -sL https://deb.nodesource.com/setup_0.12 | sudo bash -
+	sudo apt-get install -y nodejs
+
+This method uses the 
+[NodeSource Linux Repositories](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories)
+(recommended).
+
+For other platforms (not supported), see the [download page](https://nodejs.org/download) or vendor instructions.
+
+Optional dependencies (only for PDF)
+------------------------------------
+
+For optional PDF support, DocGen requires **[wkhtmltopdf](http://wkhtmltopdf.org)**. See the wkthmltopdf website for
+installation instructions.
+
+Quick install with NPM
+----------------------
+
+The quickest way to install DocGen is with **[npm](https://www.npmjs.com)** (the JavaScript package manager). Enter 
+these terminal commands:
+
+	sudo npm install -g docgen-tool
+
+Install by direct download
+--------------------------
+
+DocGen can also be installed by [direct download](https://github.com/mtmacdonald/docgen).