active-markdown - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

package.json

 {
   "name": "active-markdown",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A tool for generating reactive documents from markdown source.",
   "preferGlobal": true,
-  "main": "bin/activemd",
+  "main": "lib/ActiveMarkdown",
   "engines": {
-    "node": "0.8.x",
+    "node": "0.10.x",
     "npm":  "1.2.x"
@@ -13,17 +13,22 @@ },
     "cli": "0.4.4-2",
-    "fs-extra": "0.6.0",
-    "showdown": "0.3.1"
+    "fs-extra": "0.6.x",
+    "showdown": "git://github.com/alecperkins/showdown.git#4d04b7855d5ed327ebbe5a917c9e9607a4188f77",
+    "underscore": "1.4.x",
+    "underscore.string": "2.3.x"
   },
   "devDependencies": {
+    "backbone": "1.0.x",
+    "browserify": "2.12.x",
+    "codemirror": "3.11.x",
     "coffee-script": "1.6.x",
-    "jade": "0.28.2",
+    "d3": "3.1.5",
     "mocha": "*",
     "should": "*",
-    "sqwish": "0.2.1",
-    "stylus": "0.32.1",
-    "uglify-js": "2.2.5",
-    "walk": "2.2.1"
+    "sqwish": "0.2.x",
+    "stylus": "0.32.x",
+    "uglify-js": "2.2.x",
+    "zepto": "git://github.com/madrobby/zepto.git#v1.0"
   },
   "bin": {
-    "activemd": "./bin/activemd"
+    "activemd": "./lib/command.js"
   },
@@ -30,0 +35,0 @@ "scripts": {

README.md

@@ -1,5 +0,11 @@
-# Active Markdown, v0.2.0
+# Active Markdown, v0.3.0
 
-[Active Markdown](http://activemarkdown.org) is a tool for making reactive documents — in the vein of [Tangle](http://worrydream.com/Tangle) — using a plain text markdown source, with a special notation for adding interactive controls and variables. The logic is determined by the contents of the code blocks, which is actually executed on-the-fly to update the variables.
+*2013-4-28*
 
+[Active Markdown](http://activemarkdown.org) is a tool for making reactive
+documents — in the vein of [Tangle](http://worrydream.com/Tangle) — using a
+plain text markdown source, with a special notation for adding interactive
+controls and variables. The logic is determined by the content of the code
+blocks, which is actually executed on-the-fly to update the variables.
+
 A sample raw Active Markdown file looks like this:
@@ -42,5 +48,14 @@
 
-…where the `[7]{wives: 1..10}` gets replaced with a slider from `1` to `10`, defaulting at `7`. Whenever the value of one of the variables is changed, the code in the given code block is executed using the current state of all the variables. Then, the variables are updated with the new state.
+…where the `[7]{wives: 1..10}` gets replaced with a slider from `1` to `10`,
+defaulting at `7`. Whenever the value of one of the variables is changed, the
+code in the given code block is executed using the current state of all the
+variables. Then, the variables are updated with the new state.
 
-The notation is similar to the syntax for images and links, but when combined with some UI code by the rendering command, creates a rich, interactive and reactive document. Inspired by [literate CoffeeScript](http://coffeescript.org/#literate) and [Tangle](http://worrydream.com/Tangle/), the goal is a lightweight format for specifying interaction without requiring the creation of a webapp. Also, the document exposes its logic directly, and allows for easy modification and experimentation.
+The notation is similar to the syntax for images and links, but when combined
+with some UI code by the rendering command, creates a rich, interactive and
+reactive document. Inspired by [literate CoffeeScript](http://coffeescript.org/#literate)
+and [Tangle](http://worrydream.com/Tangle/), the goal is a lightweight format
+for specifying interaction without requiring the creation of a webapp. Also,
+the document exposes its logic directly, and allows for easy modification and
+experimentation.
 
@@ -51,10 +66,14 @@ [text value]{var_name}                  - interpolated variable (readonly)
 
-The code blocks have access to these variables under the top-level `this` object. Also, the code blocks are *editable*, and recompiled for every execution, allowing for additional interactivity. (Note: the code in the code blocks MUST be [CoffeeScript](http://coffeescript.org).)
+The code blocks have access to these variables under the top-level `this`
+object. Also, the code blocks are *editable*, and recompiled for every execution,
+allowing for additional interactivity. (Note: the code in the code blocks MUST
+be [CoffeeScript](http://coffeescript.org).)
 
-This is still experimental, and very rough around the edges. For more information, see the [initial writeup](http://activemarkdown.org/an-experiment.html).
+This is still experimental, and very rough around the edges. For more
+information, see the [initial writeup](http://activemarkdown.org/an-experiment.html).
 
-Active Markdown uses [Showdown](https://github.com/coreyti/showdown) for markdown–HTML conversion, with the `github` and `table` extensions enabled.
+Active Markdown uses [Showdown](https://github.com/coreyti/showdown) for
+markdown–HTML conversion, with the `github` and `table` extensions enabled.
 
 
-
 ## 0–60 (getting started)
@@ -74,3 +93,3 @@
         $ activemd --sample
-        Generating sample: sample.md
+        Generating sample: am_sample.md
 
@@ -85,6 +104,6 @@ $ activemd --sample > some_name.md
 
-
 ## Usage
 
-The basic usage is `activemd FILE`. This will compile a markdown file with the Active Markdown notation into an HTML file
+The basic usage is `activemd FILE`. This will compile a markdown file with the
+Active Markdown notation into an HTML file
 
@@ -99,4 +118,4 @@ activemd [options] FILE(S)
 
-        http://activemarkdown.org/viewer/activemarkdown-X.Y.Z-min.css
-        http://activemarkdown.org/viewer/activemarkdown-X.Y.Z-min.js
+        http://activemarkdown.org/viewer/activemarkdown-0.3.0-min.css
+        http://activemarkdown.org/viewer/activemarkdown-0.3.0-min.js
 
@@ -108,2 +127,5 @@ *   `-i  --inline`
 
+*   `-c  --collapsed_code`
+    Collapse the code blocks by default.
+
 *   `    --title TITLE`
@@ -116,12 +138,27 @@ Use the specified string as the title of the compiled HTML file.
 
+*   `    --debug`
+    Set the debug flag when compiling, using unminified versions of the viewer
+    asset files and providing error feedback.
 
+
 ## Notation
 
-The notation for specifying elements is similar to the regular Markdown syntax for links and images, generally following this format:
+The notation for specifying elements is similar to the regular Markdown syntax
+for links and images, generally following this format:
 
 `[text content]{variable_name: configuration}`
 
-See [activemarkdown.org/reference.html](http://activemarkdown.org/reference.html) for a complete reference of the elements and their configuration.
+See [docs/reference.html](http://activemarkdown.org/reference.html) for a
+complete reference of the elements and their configuration.
 
 
+## API
+
+The `ActiveMarkdown` module allows for programmatic parsing of Active Markdown,
+in Node via `require 'active-markdown'`, or in the browser by including the
+[script asset file](http://activemarkdown.org/viewer/activemarkdown-0.3.0-min.js).
+
+See [docs/api.html](http://activemarkdown.org/api.html) for details.
+
+
 ## Authors
@@ -131,12 +168,21 @@
 
-Thanks to [J Voight](https://github.com/joyrexus), [Alex Cabrera](http://alexcabrera.me/), [John Debs](http://johndebs.com/), and [Supriyo Sinha](http://supriyosinha.com) for help with the notation.
+Thanks to [J Voight](https://github.com/joyrexus), [Alex
+Cabrera](http://alexcabrera.me/), [John Debs](http://johndebs.com/), and
+[Supriyo Sinha](http://supriyosinha.com) for help with the notation.
 
-The concept and controls are heavily influenced by [Bret Victor’s](http://worrydream.com) [Tangle](http://worrydream.com/Tangle) library for creating reactive documents.
+The concept and controls are heavily influenced by [Bret
+Victor’s](http://worrydream.com) [Tangle](http://worrydream.com/Tangle)
+library for creating reactive documents.
 
-* [You?](https://github.com/alecperkins/active-markdown/issues) - Active Markdown is still very experimental, and input on the notation, bugs, use cases, control elements, and anything else is very welcome.
+* [You?](https://github.com/alecperkins/active-markdown/issues) - Active
+Markdown is still very experimental, and input on the notation, bugs, use
+cases, control elements, and anything else is very welcome.
 
+
 ## License
 
-Unless otherwise noted, this software is Unlicensed, aka Public Domain. See [/UNLICENSE](https://github.com/alecperkins/active-markdown/blob/master/UNLICENSE) for more information.
+Unless otherwise noted, this software is Unlicensed, aka Public Domain. See
+[/UNLICENSE](https://github.com/alecperkins/active-markdown/blob/master/UNLICENSE)
+for more information.
 
 

New alerts

Git dependency

Supply chain risk

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable and can be used to inject untrusted code or reduce the likelihood of a reproducible install.

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

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1777222

increased by9.14%

Lines of code

25601

increased by23.53%

Number of low quality alerts

3

decreased by-25%

Number of lines in readme file

181

increased by34.07%

Number of low supply chain risk alerts

12

decreased by-50%

Number of medium supply chain risk alerts

11

decreased by-31.25%

Worsened metrics

Dependency count

5

increased by66.67%

Dev dependency count

11

increased by37.5%

Number of package files

23

decreased by-37.84%

Number of high supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedunderscore@1.4.x

• + Addedunderscore.string@2.3.x

• + Addedfs-extra@0.6.4(transitive)

• + Addedjsonfile@1.0.1(transitive)

• + Addedrimraf@2.2.8(transitive)

• + Addedunderscore@1.4.4(transitive)

• + Addedunderscore.string@2.3.3(transitive)

• - Removedfs-extra@0.6.0(transitive)

• - Removedgraceful-fs@1.2.3(transitive)

• - Removedjsonfile@0.0.1(transitive)

• - Removedrimraf@2.1.4(transitive)

• - Removedshowdown@0.3.1(transitive)

• Updatedfs-extra@0.6.x

• Updatedshowdown@git://github.com/alecperkins/showdown.git#4d04b7855d5ed327ebbe5a917c9e9607a4188f77