live-guide
Advanced tools
Comparing version 0.6.4 to 0.6.5
{ | ||
"name": "live-guide", | ||
"version": "0.6.4", | ||
"version": "0.6.5", | ||
"description": "Generate style guides based on commented style sheets.", | ||
@@ -5,0 +5,0 @@ "author": { |
@@ -26,2 +26,16 @@ live-guide | ||
``` | ||
## Command Line API | ||
```shell | ||
Options: | ||
--input, -i file(s) (glob pattern) that should be evaulated and built into | ||
the Styleguide [required] | ||
--output, -o Where should the output styleguide go? Defaults to current | ||
working directory /styleguide | ||
--resource, -r additional resources to be loaded into the code example | ||
iframes [array] | ||
--name, -n name for the style guide or product | ||
--help, -h Show help [boolean] | ||
``` | ||
## Module API | ||
@@ -28,0 +42,0 @@ |
@@ -10,3 +10,3 @@ 'use strict'; | ||
obj.description = obj.description ? `**Description:** ${obj.description}` : ''; | ||
obj.notes = obj.notes ? `*${obj.notes}*` : ''; | ||
obj.notes = obj.notes ? `*${obj.notes}*\n` : ''; | ||
obj.example = obj.example ? `**Example:**\n\`\`\`\n${obj.example.join('\n\n')}\n\`\`\`` : ''; | ||
@@ -17,5 +17,3 @@ | ||
${obj.description} | ||
${obj.notes} | ||
${obj.example} | ||
@@ -22,0 +20,0 @@ `; |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
32169
129