docgen-tool 2.1.2 → 3.0.0

package/source/user-guide/advanced-content.txt

@@ -1,171 +1,171 @@
-<style>
-.container {
-  box-sizing: border-box;
-  float:left;
-  width: 480px;
-}
-.codeContainer {
-  margin: 0 20px 0 0;
-}
-.codeContainer pre {
-  margin: 0;
-}
-.codeContainer code {
-}
-.codeContainer p {
-  margin: 0;
-  padding: 0;
-}
-.exampleContainer {
-  margin: 0;
-  border: 1px solid #666;
-  border-radius: 6px;
-  padding: 0 18px 0 18px;
-}
-.exampleContainer img {
-  margin-top: 5px;
-}
-#content table {
-  width: 400px!important;
-}
-.hljs-change {
-  background-color: initial!important;
-}
-</style>
-
-Advanced styles
----------------
-
-DocGen is built on the [Webknife CSS framework](http://mtmacdonald.github.io/webknife). Any of the HTML elements and 
-styles from Webknife can be used in a DocGen source file. For details, see 
-the [Webknife reference guide](http://mtmacdonald.github.io/webknife/docs/reference.html).
-
-Basic tables
-------------
-
-Basic tables can be inserted with the Github-flavoured Markdown
-[table extension](https://help.github.com/articles/github-flavored-markdown/#tables).
-
-<div class="container codeContainer">
-<pre><code>| Heading    | Heading    | Heading |
-|:-----------:----------:|--------:|
-| Something  | Something  | ?       |
-| Another    | Another    | ?       |
-| One more   | One more   | ?       |</code></pre>
-</div>
-<div class="container exampleContainer">
-<table class="w-table w-fixed w-stripe">
-<thead>
-<tr>
-<th style="text-align:left">Heading</th>
-<th style="text-align:center">Heading</th>
-<th style="text-align:right">Heading</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td style="text-align:left">Something</td>
-<td style="text-align:center">Something</td>
-<td style="text-align:right">?</td>
-</tr>
-<tr>
-<td style="text-align:left">Another</td>
-<td style="text-align:center">Another</td>
-<td style="text-align:right">?</td>
-</tr>
-<tr>
-<td style="text-align:left">One more</td>
-<td style="text-align:center">One more</td>
-<td style="text-align:right">?</td>
-</tr>
-</tbody>
-</table>
-</div><br class="w-clear"/>
-
-HTML tables
------------
-
-Regular HTML can also be used for tables, allowing full custom styling (including table and column widths).
-
-<div class="container codeContainer">
-<pre><code>&lt;table style=&quot;width:100%;&quot;&gt;
- &lt;tr&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td class=&quot;bold&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;Example&lt;/td&gt;
-  &lt;td&gt;Example&lt;/td&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
-  &lt;td class=&quot;w-success-text&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;checkmark&quot;&gt;&lt;/span&gt;&lt;/td&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
-  &lt;td class=&quot;w-error-text&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;close&quot;&gt;&lt;/td&gt;
- &lt;/tr&gt;
-&lt;/table&gt;</code></pre>
-</div>
-<div class="container exampleContainer">
-<table style="width:100%;">
- <tr>
-  <th>Heading</th>
-  <th>Heading</th>
-  <th>Heading</th>
- </tr>
- <tr>
-  <td class="bold">Example</td>
-  <td>Example</td>
-  <td>Example</td>
- </tr>
- <tr>
-  <td><strong>Example</strong></td>
-  <td class="w-success-text">Example</td>
-  <td><span class="w-icon" data-name="checkmark"></span></td>
- </tr>
- <tr>
-  <td><strong>Example</strong></td>
-  <td class="w-error-text">Example</td>
-  <td><span class="w-icon" data-name="close"></td>
- </tr>
-</table>
-</div><br class="w-clear"/>
-
-Creating internal links to page sections
-----------------------------------------
-
-To create links to other sections within one content page, put hyphens between the words in the heading and prepend with #:
-
-	[link to heading](#this-is-a-heading)
-
-	... other page content here ...
-	
-	This is a heading
-	-----------------
-
-Creating internal links to other pages
---------------------------------------
-
-To create links to *other* content pages provide the relative url to the page:
-
-	[link to heading](example-page.html)
-
-Control of page breaks in the PDF
----------------------------------
-
-DocGen does not provide precision control over PDF layout. However, some steps can be taken in case of page break 
-issues (the most common problem).
-
-To *force* a page break, insert the following before an element that should appear on a new page:
-
-	<p class="dg-forceBreak"></p>
-
-DocGen automatically tries to eliminate page breaks *inside* code blocks, block quotes, and table rows. 
-To apply the same technique to other elements, revert to HTML and apply the **dg-avoidBreak** class. For example:
-
+<style>
+.container {
+  box-sizing: border-box;
+  float:left;
+  width: 480px;
+}
+.codeContainer {
+  margin: 0 20px 0 0;
+}
+.codeContainer pre {
+  margin: 0;
+}
+.codeContainer code {
+}
+.codeContainer p {
+  margin: 0;
+  padding: 0;
+}
+.exampleContainer {
+  margin: 0;
+  border: 1px solid #666;
+  border-radius: 6px;
+  padding: 0 18px 0 18px;
+}
+.exampleContainer img {
+  margin-top: 5px;
+}
+#content table {
+  width: 400px!important;
+}
+.hljs-change {
+  background-color: initial!important;
+}
+</style>
+
+Advanced styles
+---------------
+
+DocGen is built on the [Webknife CSS framework](http://mtmacdonald.github.io/webknife). Any of the HTML elements and 
+styles from Webknife can be used in a DocGen source file. For details, see 
+the [Webknife reference guide](http://mtmacdonald.github.io/webknife/docs/reference.html).
+
+Basic tables
+------------
+
+Basic tables can be inserted with the Github-flavoured Markdown
+[table extension](https://help.github.com/articles/github-flavored-markdown/#tables).
+
+<div class="container codeContainer">
+<pre><code>| Heading    | Heading    | Heading |
+|:-----------:----------:|--------:|
+| Something  | Something  | ?       |
+| Another    | Another    | ?       |
+| One more   | One more   | ?       |</code></pre>
+</div>
+<div class="container exampleContainer">
+<table class="w-table w-fixed w-stripe">
+<thead>
+<tr>
+<th style="text-align:left">Heading</th>
+<th style="text-align:center">Heading</th>
+<th style="text-align:right">Heading</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td style="text-align:left">Something</td>
+<td style="text-align:center">Something</td>
+<td style="text-align:right">?</td>
+</tr>
+<tr>
+<td style="text-align:left">Another</td>
+<td style="text-align:center">Another</td>
+<td style="text-align:right">?</td>
+</tr>
+<tr>
+<td style="text-align:left">One more</td>
+<td style="text-align:center">One more</td>
+<td style="text-align:right">?</td>
+</tr>
+</tbody>
+</table>
+</div><br class="w-clear"/>
+
+HTML tables
+-----------
+
+Regular HTML can also be used for tables, allowing full custom styling (including table and column widths).
+
+<div class="container codeContainer">
+<pre><code>&lt;table style=&quot;width:100%;&quot;&gt;
+ &lt;tr&gt;
+  &lt;th&gt;Heading&lt;/th&gt;
+  &lt;th&gt;Heading&lt;/th&gt;
+  &lt;th&gt;Heading&lt;/th&gt;
+ &lt;/tr&gt;
+ &lt;tr&gt;
+  &lt;td class=&quot;bold&quot;&gt;Example&lt;/td&gt;
+  &lt;td&gt;Example&lt;/td&gt;
+  &lt;td&gt;Example&lt;/td&gt;
+ &lt;/tr&gt;
+ &lt;tr&gt;
+  &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
+  &lt;td class=&quot;w-success-text&quot;&gt;Example&lt;/td&gt;
+  &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;checkmark&quot;&gt;&lt;/span&gt;&lt;/td&gt;
+ &lt;/tr&gt;
+ &lt;tr&gt;
+  &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
+  &lt;td class=&quot;w-error-text&quot;&gt;Example&lt;/td&gt;
+  &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;close&quot;&gt;&lt;/td&gt;
+ &lt;/tr&gt;
+&lt;/table&gt;</code></pre>
+</div>
+<div class="container exampleContainer">
+<table style="width:100%;">
+ <tr>
+  <th>Heading</th>
+  <th>Heading</th>
+  <th>Heading</th>
+ </tr>
+ <tr>
+  <td class="bold">Example</td>
+  <td>Example</td>
+  <td>Example</td>
+ </tr>
+ <tr>
+  <td><strong>Example</strong></td>
+  <td class="w-success-text">Example</td>
+  <td><span class="w-icon" data-name="checkmark"></span></td>
+ </tr>
+ <tr>
+  <td><strong>Example</strong></td>
+  <td class="w-error-text">Example</td>
+  <td><span class="w-icon" data-name="close"></td>
+ </tr>
+</table>
+</div><br class="w-clear"/>
+
+Creating internal links to page sections
+----------------------------------------
+
+To create links to other sections within one content page, put hyphens between the words in the heading and prepend with #:
+
+	[link to heading](#this-is-a-heading)
+
+	... other page content here ...
+	
+	This is a heading
+	-----------------
+
+Creating internal links to other pages
+--------------------------------------
+
+To create links to *other* content pages provide the relative url to the page:
+
+	[link to heading](example-page.html)
+
+Control of page breaks in the PDF
+---------------------------------
+
+DocGen does not provide precision control over PDF layout. However, some steps can be taken in case of page break 
+issues (the most common problem).
+
+To *force* a page break, insert the following before an element that should appear on a new page:
+
+	<p class="dg-forceBreak"></p>
+
+DocGen automatically tries to eliminate page breaks *inside* code blocks, block quotes, and table rows. 
+To apply the same technique to other elements, revert to HTML and apply the **dg-avoidBreak** class. For example:
+
 	<p class="dg-avoidBreak">A long paragraph</p>

package/source/user-guide/contents.json

@@ -1,57 +1,57 @@
 [
-	{
-		"heading" : "Quick Start",
-		"column" : 1,
-		"pages" : [
-			{
-				"title": "Overview",
-				"source": "index.txt",
-				"html": true
-			},
-			{
-				"title": "Installation",
-				"source": "installation.txt"
-			},
-			{
-				"title": "Upgrading",
-				"source": "upgrading.txt"
-			}
-		]
-	},
-	{
-		"heading" : "User Guide",
-		"column" : 2,
-		"pages" : [
-			{
-				"title": "Running DocGen",
-				"source": "running.txt"
-			},
-			{
-				"title": "Writing content",
-				"source": "writing-content.txt"
-			},
-			{
-				"title": "CommonMark reference",
-				"source": "commonmark.txt"
-			},
-			{
-				"title": "Advanced content",
-				"source": "advanced-content.txt"
-			}
-		]
-	},
-	{
-		"heading" : "Help",
-		"column" : 3,
-		"pages" : [
-			{
-				"title": "Troubleshooting",
-				"source": "troubleshooting.txt"
-			},
-			{
-				"title": "Using with version control",
-				"source": "version-control.txt"
-			}
-		]
-	}
-]
+  {
+    "heading": "Quick Start",
+    "column": 1,
+    "pages": [
+      {
+        "title": "Overview",
+        "source": "index.txt",
+        "html": true
+      },
+      {
+        "title": "Installation",
+        "source": "installation.txt"
+      },
+      {
+        "title": "Upgrading",
+        "source": "upgrading.txt"
+      }
+    ]
+  },
+  {
+    "heading": "User Guide",
+    "column": 2,
+    "pages": [
+      {
+        "title": "Running DocGen",
+        "source": "running.txt"
+      },
+      {
+        "title": "Writing content",
+        "source": "writing-content.txt"
+      },
+      {
+        "title": "CommonMark reference",
+        "source": "commonmark.txt"
+      },
+      {
+        "title": "Advanced content",
+        "source": "advanced-content.txt"
+      }
+    ]
+  },
+  {
+    "heading": "Help",
+    "column": 3,
+    "pages": [
+      {
+        "title": "Troubleshooting",
+        "source": "troubleshooting.txt"
+      },
+      {
+        "title": "Using with version control",
+        "source": "version-control.txt"
+      }
+    ]
+  }
+]

package/source/user-guide/files/images/svg/inkit-logo.svg

@@ -0,0 +1,9 @@
+<svg width="417" height="101" viewBox="0 0 417 101" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M80.0297 0.904297V35.2876L104.013 46.8376L67.9297 64.4543V100.554L132.763 68.1376C135.68 66.6876 137.513 63.7043 137.513 60.4543V34.9876C137.513 31.7376 135.68 28.7543 132.763 27.3043L80.0297 0.937625V0.904297Z" fill="#010203"/>
+<path d="M69.7279 0.904434L4.89453 33.3211C1.97787 34.7711 0.144531 37.7544 0.144531 41.0044V66.4711C0.144531 69.7211 1.97787 72.7044 4.89453 74.1544L57.6279 100.521V64.4211L33.6445 52.8711L69.7279 35.2544V0.871094V0.904434Z" fill="#010203"/>
+<path d="M166.145 20.0547H178.628V74.0213H166.145V20.0547Z" fill="#010203"/>
+<path d="M248.645 20.0547V74.0213H238.395L211.478 41.2547V74.0213H199.145V20.0547H209.478L236.311 52.8213V20.0547H248.645Z" fill="#010203"/>
+<path d="M291.71 52.8213L284.46 60.3713V74.0213H272.043V20.0547H284.46V45.2713L308.36 20.0547H322.243L299.876 44.1047L323.543 74.0213H308.976L291.71 52.8213Z" fill="#010203"/>
+<path d="M338.293 20.0547H350.776V74.0213H338.293V20.0547Z" fill="#010203"/>
+<path d="M387.028 30.238H369.762V20.0547H416.795V30.238H399.528V74.038H387.045V30.238H387.028Z" fill="#010203"/>
+</svg>