styledocco - npm Package Compare versions

Comparing version 0.3.4 to 0.3.5

package.json

@@ -9,3 +9,3 @@ {
   "author": "Jacob Rask <[e-mail]>",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "homepage": "http://jacobrask.github.com/styledocco/",
@@ -12,0 +12,0 @@ "licenses": [

README.md

@@ -26,3 +26,3 @@ ```
 
-or clone the [GitHub repository](https://github.com/jacobrask/styledocco).
+or check out this repository.
 
@@ -59,30 +59,19 @@ StyleDocco is free software, released under the [MIT license](https://raw.github.com/jacobrask/styledocco/master/LICENSE).
 
-## Examples
+## Syntax examples
 
-This page is an example itself, as it was generated from the StyleDocco readme file. The [docs](resources/docs.html) file is the documentation of the default StyleDocco CSS file.
+    /* Provides extra visual weight and identifies the primary action in a set of buttons.
 
-An additional example was generated from a modified file of the [Twitter Bootstrap](examples/bootstrap/docs/less/buttons.html) project.
-
-### *Stylesheet*
-
-    /* Provides extra visual weight and identifies the primary action in a set of buttons.
-    
         <button class="btn primary">Primary</button> */
     .btn.primary {
-        background: steelblue;
-        color: snow;
-        border: 1px solid steelblue;
+        background: blue;
+        color: white;
     }
 
-### *Output*
+Would display the description, a rendered button as well as the example HTML code. The CSS will be included in the `style` element of the document.
 
-Provides extra visual weight and identifies the primary action in a set of buttons.
+See the `examples` folder for more in-depth examples.
 
-<div class="styledocco-example"><button class="btn primary" style="background:steelblue;color:snow;border:2px outset steelblue">Primary</button></div><pre><code><span class="tag">&lt;<span class="title">button</span> <span class="attribute">class</span>=<span class="value">"btn primary"</span>></span>Primary<span class="tag">&lt;/<span class="title">button</span>></span></code></pre>
 
-
 ## Acknowledgements
 
 A lot of the heavy lifting in StyleDocco is done by the excellent [Marked](https://github.com/chjj/marked) module by Christopher Jeffrey. The original [Docco](https://github.com/jashkenas/docco) by Jeremy Ashkenas and [Docco Husky](https://github.com/mbrevoort/docco-husky) by Mike Brevoort were also of great help to this project. [Knyle Style Sheets](https://github.com/kneath/kss), a similar project written in Ruby, has also been an inspiration to StyleDocco.
-
-<a href="https://github.com/jacobrask/styledocco" id="styledocco-fork-me"><img style="position:fixed;top:0;right:0;border:0;" src="https://a248.e.akamai.net/assets.github.com/img/7afbc8b248c68eb468279e8c17986ad46549fb71/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub"></a>

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

Worsened metrics

Total package byte prevSize

638682

decreased by-12.65%

Number of package files

73

decreased by-6.41%

Lines of code

1533

decreased by-19.86%

Number of lines in readme file

76

decreased by-12.64%

No dependency changes