Added main class api doc

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
 coverage/
 demo/
+apidoc/
 *.log

.ndocrc

@@ -0,0 +1,25 @@
+#
+# Common nodeca config
+################################################################################
+
+--index         "./README.md"
+--package       "./package.json"
+--gh-ribbon     "{package.homepage}"
+--output        "apidoc"
+--render        "html"
+--link-format   "{package.homepage}/blob/master/{file}#L{line}"
+--broken-links  "show"
+
+
+#
+# Paths with sources
+################################################################################
+
+lib
+
+
+#
+# Project specific configuration
+################################################################################
+
+--show-all

.npmignore

@@ -2,6 +2,7 @@ benchmark/
 coverage/
 demo/
 docs/
+apidoc/
 support/
 test/
 Makefile

Makefile

@@ -44,7 +44,7 @@ lint:
 	eslint --reset .
 
 test: lint
-	NODE_ENV=test mocha -R spec
+	mocha -R spec
 	echo "CommonMark stat:\n"
 	./support/specsplit.js test/fixtures/commonmark/spec.txt
 
@@ -55,6 +55,15 @@ coverage:
 test-ci: lint
 	istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage
 
+apidoc:
+	@if test ! `which ndoc` ; then \
+		echo "You need 'ndoc' installed in order to generate docs." >&2 ; \
+		echo "  $ npm install -g ndoc" >&2 ; \
+		exit 128 ; \
+		fi
+	rm -rf ./apidoc
+	ndoc --link-format "{package.homepage}/blob/${CURR_HEAD}/{file}#L{line}"
+
 publish:
 	@if test 0 -ne `git status --porcelain | wc -l` ; then \
 		echo "Unclean working tree. Commit or stash changes first." >&2 ; \
@@ -87,5 +96,5 @@ todo:
 	grep 'TODO' -n -r ./lib 2>/dev/null || test true
 
 
-.PHONY: publish lint test gh-pages todo demo coverage
+.PHONY: publish lint test gh-pages todo demo coverage apidoc
 .SILENT: help lint test todo

README.md

@@ -62,7 +62,7 @@ var md = window.markdownit();
 console.log(md.render('# markdown-it rulezz!'));
 ```
 
-Single lines rendering, without paragraph wrap:
+Single line rendering, without paragraph wrap:
 
 ```js
 var md = require('markdown-it')();
@@ -88,7 +88,7 @@ active syntax rules and options for common use cases.
   all rules enabled, but still without html, typographer & autolinker.
 - [default](https://github.com/markdown-it/markdown-it/blob/master/lib/presets/default.js) -
   when no preset name given.
-- [zero](https://github.com/markdown-it/markdown-it/blob/master/lib/presets/zero.js) -
+- ["zero"](https://github.com/markdown-it/markdown-it/blob/master/lib/presets/zero.js) -
   all rules disabled (useful to quickly setup your config via `.enable()`).
 
 

bower.json

@@ -17,6 +17,7 @@
     "coverage",
     "demo",
     "docs",
+    "apidoc",
     "lib",
     "node_modules",
     "support",