markdown-styles - npm Package Compare versions

Comparing version 1.1.4 to 1.1.5

package.json

 {
   "name": "markdown-styles",
   "description": "CSS stylesheets for markdown content",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "author": {
@@ -10,2 +10,6 @@ "name": "Mikito Takada",
   },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/mixu/markdown-styles.git"
+  },
   "bin": {
@@ -16,9 +20,9 @@ "generate-md": "./bin/generate-md"
   "dependencies": {
-    "marked": "~0.2.5",
-    "ncp": "~0.4.0",
+    "marked": "0.2.9",
+    "ncp": "0.4.2",
     "minitask": "0.0.0",
-    "readable-stream": "~1.0.2",
-    "mkdirp": "~0.3.5",
-    "nopt": "~2.1.1"
+    "readable-stream": "1.0.2",
+    "mkdirp": "0.3.5",
+    "nopt": "2.1.2"
   }
 }

readme.md

@@ -10,7 +10,33 @@ ## Features
 -----
+## Quickstart
 
-## Using the CSS stylesheets
+Install `generate-md` via npm:
 
-If you just want the stylesheets, you can just copy the `./assets` folder from the layout you want.
+    sudo npm install -g markdown-styles
 
+Create a markdown file and then convert it to html:
+
+    mkdir input/
+    echo "# Hello world\n YOLO" > input/index.md
+    generate-md --layout mixu-gray --input ./input --output ./output
+    google-chrome ./output/index.html
+
+Try out different layouts by changing the `--layout` parameter; screenshots at the bottom of this page.
+
+If you want to make use of the bundled layouts stylesheets as a basis for your own site, copy the ./assets folder and point `--layout` to your own layout.
+
+For example:
+
+    git clone https://github.com/mixu/markdown-styles.git ./markdown-styles
+    cp -Rv ./markdown-styles/layouts/mixu-gray ./my-layout
+    nano ./my-layout/page.html
+
+Now edit the files `./my-layout/page.html` and run:
+
+    generate-md --layout ./my-layout/page.html --input ./input --output ./output
+
+## Just using the stylesheets
+
+Alternatively, if you just want the stylesheets for your own project, you can just copy the `./assets` folder from the layout you want.
+
 To preview the styles in the browser, clone this repo locally and then open `./output/index.html` or run `make preview` which opens that page in your default browser.
@@ -20,3 +46,3 @@
 
-This repo also includes a small tool for generating HTML files from Markdown files.
+This project also includes a small tool for generating HTML files from Markdown files.
 
@@ -110,2 +136,3 @@ The console tool is `generate-md`, e.g.
 - markedapp-byword is based on the user-contributed stylesheet at http://bywordapp.com/extras/
+- roryg-ghostwriter is based on https://github.com/roryg/ghostwriter
 
@@ -116,2 +143,18 @@ ## Screenshots of the layouts
 
+### roryg-ghostwriter (new!)
+
+![roryg-ghostwriter](https://github.com/mixu/markdown-styles/raw/master/screenshots/roryg-ghostwriter.png)
+
+### mixu-bootstrap (new!)
+
+![mixu-bootstrap](https://github.com/mixu/markdown-styles/raw/master/screenshots/mixu-bootstrap.png)
+
+### mixu-bootstrap-2col (new!)
+
+![mixu-bootstrap-2col](https://github.com/mixu/markdown-styles/raw/master/screenshots/mixu-bootstrap-2col.png)
+
+### mixu-gray (new!)
+
+![mixu-gray](https://github.com/mixu/markdown-styles/raw/master/screenshots/mixu-gray.png)
+
 ### jasonm23-dark
@@ -149,14 +192,2 @@
 
-### mixu-bootstrap (new!)
-
-![mixu-bootstrap](https://github.com/mixu/markdown-styles/raw/master/screenshots/mixu-bootstrap.png)
-
-### mixu-bootstrap-2col (new!)
-
-![mixu-bootstrap-2col](https://github.com/mixu/markdown-styles/raw/master/screenshots/mixu-bootstrap-2col.png)
-
-### mixu-gray (new!)
-
-![mixu-gray](https://github.com/mixu/markdown-styles/raw/master/screenshots/mixu-gray.png)
-
 ### thomasf-solarizedcssdark
@@ -163,0 +194,0 @@

Fixed alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4702491

increased by1.82%

Number of package files

160

increased by5.96%

Lines of code

59879

increased by2.57%

Number of lines in readme file

219

increased by16.49%

Number of low supply chain risk alerts

4

decreased by-20%

Dependency changes

• + Addedmarked@0.2.9(transitive)

• + Addedreadable-stream@1.0.2(transitive)

• - Removedcore-util-is@1.0.3(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedisarray@0.0.1(transitive)

• - Removedmarked@0.2.10(transitive)

• - Removedreadable-stream@1.0.34(transitive)

• - Removedstring_decoder@0.10.31(transitive)

• Updatedmarked@0.2.9

• Updatedmkdirp@0.3.5

• Updatedncp@0.4.2

• Updatednopt@2.1.2

• Updatedreadable-stream@1.0.2