documentary - npm Package Compare versions

Comparing version 1.8.0 to 1.8.1

build/lib/rules/type.js

		@@ -101,20 +101,22 @@ "use strict";
		const nn = tocTitles ? `[${n}](t)` : n;
		return `
		<tr>
		const e = example.startsWith('```') ? `\n\n${example}` : example;
		return ` <tr>
		<td>${nn}</td>

		<td>${tag('em', type)}</td>
		<td>${description}</td>
		<td>${example.startsWith('```') ? '\n\n' : ''}${example}
		</td>
		</tr>`;
		<td>${e}</td>
		</tr>`;
		});
		return `<table>
		<thead>
		<tr>
		<th>Property</th>
		<th>Type</th>
		<th>Description</th>
		<th>Example</th>
		<th>Property</th>
		<th>Type</th>
		<th>Description</th>
		<th>Example</th>
		</tr>
		</thead>
		<tbody>
		${rows.join('\n')}
		</tbody>
		</table>
		@@ -121,0 +123,0 @@ `;

CHANGELOG.md

		@@ -0,1 +1,9 @@
		## 30 June 2018

		### 1.8.1

		- [fix] tidy up table markup spacing
		- [doc] xml type to `Type` examples
		- [package] easy commit `doc` commands

		## 26 June 2018
		@@ -2,0 +10,0 @@

package.json

		{
		"name": "documentary",
		"version": "1.8.0",
		"version": "1.8.1",
		"description": "A library to manage documentation, such as README, usage, man pages and changelog.",
		@@ -15,2 +15,6 @@ "main": "build",
		"dev": "NODE_DEBUG=doc node src/bin/register",
		"d": "yarn-s doc_add doc_commit doc_push",
		"doc_add": "git add documentation README.md",
		"doc_commit": "git commit -m doc",
		"doc_push": "git push",
		"doc": "yarn dev documentation -o README.md",
		@@ -22,3 +26,3 @@ "start": "node build/bin",
		"b": "b --source-maps --ignore src/bin/register.js",
		"build": "yarn-s build-src doc"
		"build": "yarn-s b doc"
		},
		@@ -25,0 +29,0 @@ "bin": {

README.md

		@@ -320,12 +320,13 @@ # documentary
		<table>
		<thead>
		<tr>
		<th>Property</th>
		<th>Type</th>
		<th>Description</th>
		<th>Example</th>
		<th>Property</th>
		<th>Type</th>
		<th>Description</th>
		<th>Example</th>
		</tr>

		<tr>
		</thead>
		<tbody>
		<tr>
		<td><strong><code>text</code></strong></td>

		<td><em>string</em></td>
		@@ -340,9 +341,6 @@ <td>Display text. Required.</td>
		```

		</td>
		</tr>

		<tr>
		</tr>
		<tr>
		<td><code>validation</code></td>

		<td><em>(async) function</em></td>
		@@ -360,5 +358,5 @@ <td>A function which needs to throw an error if validation does not pass.</td>
		```

		</td>
		</tr>
		</tr>
		</tbody>
		</table>
		@@ -369,3 +367,3 @@

		```
		```xml
		%TYPE true
		@@ -414,12 +412,13 @@ <p name="skipLevelOne" type="boolean">
		<table>
		<thead>
		<tr>
		<th>Property</th>
		<th>Type</th>
		<th>Description</th>
		<th>Example</th>
		<th>Property</th>
		<th>Type</th>
		<th>Description</th>
		<th>Example</th>
		</tr>

		<tr>
		</thead>
		<tbody>
		<tr>
		<td><a name="skiplevelone"><code>skipLevelOne</code></a></td>

		<td><em>boolean</em></td>
		@@ -453,5 +452,5 @@ <td>Start the table of contents from level 2, i.e., excluding the <code>#</code> title.</td>
		when `skipLevelOne` is set to `false`.

		</td>
		</tr>
		</tr>
		</tbody>
		</table>
		@@ -458,0 +457,0 @@

build/lib/rules/type.js.map

Sorry, the diff of this file is not supported yet

New alerts