live-guide
Advanced tools
Comparing version 0.6.0 to 0.6.1
{ | ||
"name": "live-guide", | ||
"version": "0.6.0", | ||
"version": "0.6.1", | ||
"description": "Generate style guides based on commented style sheets.", | ||
@@ -5,0 +5,0 @@ "author": { |
@@ -30,2 +30,3 @@ live-guide | ||
**@author**: Contribute the code to someone | ||
**pattern**: `/@author[^\S\n]+?(.+)/g` | ||
@@ -35,2 +36,3 @@ | ||
**@description**: Set a description for this section of the styleguide, generally used after an `@title` | ||
**pattern**: `/@description[^\S\n]+?(.+)/g` | ||
@@ -40,2 +42,3 @@ | ||
**@example**: A code example, similar to writing ``` in Markdown | ||
**pattern**: `/^@example(.*?)?$\s((?:^.+$\s?)+)/gm` | ||
@@ -45,2 +48,3 @@ | ||
**@title**: The title of the component, module or API you are developing | ||
**pattern**: `/^@title (.*)$/gm` | ||
@@ -50,2 +54,3 @@ | ||
**@todo**: Let users know what needs to be done in this section of your style guide | ||
**pattern**: `/^@(?:todo|task) (.*)$/gm` | ||
@@ -55,2 +60,3 @@ | ||
**@url**: Add a link to the styleguide, automatically opens in a new tab | ||
**pattern**: `/@url[^\S\n]+?(.+)/g` | ||
@@ -60,2 +66,3 @@ | ||
**@wrietName**: If you want the file name to be different than the title, for instance setting up an index page. *There is no need to provide a file extension* | ||
**pattern**: `/@writeName(.+)/g` | ||
@@ -62,0 +69,0 @@ |
@@ -11,2 +11,3 @@ 'use strict'; | ||
**@${key}**: ${obj.description} | ||
**pattern**: \`${obj.pattern}\` | ||
@@ -13,0 +14,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
30452
78