styledocco - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

lib/main.js

@@ -257,3 +257,2 @@ (function() {
     if (source.match(/(\/|^)\./)) return false;
-    if (source.match(/(\/|^)_.*\.s[ac]ss$/)) return false;
     if (!(path.extname(source) in languages)) return false;
@@ -260,0 +259,0 @@ if (!fs.statSync(source).isFile()) return false;

package.json

@@ -10,7 +10,7 @@ {
   "author": "Jacob Rask <[e-mail]>",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "licenses": [
     {
       "type": "MIT",
-      "url": "http://opensource.org/licenses/mit-license.php"
+      "url": "http://github.com/jacobrask/styledocco/raw/master/LICENSE"
     }
@@ -17,0 +17,0 @@ ],

README.md

@@ -8,21 +8,17 @@ _______ __         __        _____
 
-About
-=====
+## About
 
-StyleDocco takes your stylesheets and generates style guide documents with the processed stylesheets applied to the documents.
+StyleDocco generates documentation and style guide documents from your stylesheets.
 
-`styledocco --name 'My Site' main.css` will generate `docs/main.html` with all the comments from the file (passed through GitHub flavored Markdown) in one column, and all the code in another column.
+It takes the comments from stylesheets and produces HTML documents that display your comments alongside your code, with any HTML snippets from the comments rendered using the processed stylesheets.
 
-The CSS in `main.css` will be applied to the page. This means you can add sample HTML content in the comments of your CSS file, and have it rendered in the browser using that same CSS.
+There is no special syntax, comments are just parsed with (GitHub flavored) Markdown. This means that the documentation will still make sense when reading the plain stylesheets, or if you decide to not keep using StyleDocco.
 
-If your project includes a `README` file, it will be used as the base for an `index.html`.
+If your project includes a `README` file, it will be used as the base for an `index.html`. StyleDocco will also add some default styles to your documentation, but they are easy to modify to make it fit with your project.
 
-StyleDocco will add `docs.css` with some default styles to your documentation, but you might want to modify it to make it fit with your project.
+StyleDocco will automatically compile any SASS, SCSS, Less or Stylus code before it is applied to the page.
 
-StyleDocco will automatically compile any SASS, SCSS, Less or Stylus code before it is applied to the page. Hidden files and SASS partials will be ignored.
 
+## Install
 
-Install
-=======
-
 StyleDocco requires [Node.js](http://nodejs.org).
@@ -32,10 +28,12 @@
 
+or checkout this repository.
 
-Usage
-=====
+StyleDocco is free software, released under the MIT license.
 
+
+## Usage
+
 `styledocco [options] [INPUT]`
 
-Options
--------
+### Options
 
@@ -48,4 +46,3 @@ * `--name`, `-n` Name of the project *(required)*
 
-Examples
-========
+## Examples
 
@@ -64,4 +61,3 @@ /* <button class="btn primary">Primary</button>
 
-Acknowledgements
-================
+## Acknowledgements
 
@@ -68,0 +64,0 @@ Thanks to:

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

106122

increased by0.31%

Number of package files

21

increased by5%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Lines of code

769

decreased by-0.9%

Number of lines in readme file

64

decreased by-5.88%

No dependency changes