Merge pull request #45 from shawnbot/merge-docs

Static docs and VERSION file

This collection of commits moves the modestmaps-js version number from src/start.js to a standalone VERSION fo;e, the contents of which is inserted into modestmaps.js (and modestmaps.min.js) by the Makefile. To update the modestmaps-js version from now on, edit the VERSION file and run `make clean all`.

These commits also include static documentation in the doc/ directory. You'll need to `npm install marked` to build them. Also not that the docs are *not* built automatically by the project-level Makefile; you'll need to `cd doc && make clean all` to rebuild the docs with the current version number. And don't forget to update the corresponding entries in doc/api.md if you make changes to the public API!

.gitignore

@@ -1 +1,3 @@
 node_modules
+.swp
+.*.swp

Makefile

@@ -17,16 +17,21 @@ JS_FILES = \
 	src/convenience.js \
 	src/end.js
 
-all: modestmaps.js modestmaps.min.js
+VERSION = `cat VERSION`
+
+all: modestmaps.js modestmaps.min.js update-version
 
 modestmaps.min.js: modestmaps.js
 	rm -f modestmaps.min.js
 	java -jar tools/yuicompressor-2.4.2.jar modestmaps.js > modestmaps.min.js
 
 modestmaps.js: $(JS_FILES) Makefile
 	rm -f modestmaps.js
-	cat $(JS_FILES) >> modestmaps.js
+	cat $(JS_FILES) | perl -pi -e "s/{VERSION}/$(VERSION)/g" > modestmaps.js
+
+update-version:
+	perl -pi -e "s/\"version\": \"[^\"]+/\"version\": \"$(VERSION)/g" package.json
 
 clean:
-	rm modestmaps.js
-	rm modestmaps.min.js
+	rm -f modestmaps.js
+	rm -f modestmaps.min.js

VERSION

@@ -0,0 +1 @@
+3.3.4

doc/.gitignore

@@ -0,0 +1,2 @@
+api.html
+toc.html

doc/Makefile

@@ -0,0 +1,15 @@
+# to install marked: `npm install marked`
+MARKED ?= ../node_modules/marked/bin/marked --gfm
+VERSION = `cat ../VERSION`
+
+all: index.html
+
+index.html: toc.html api.html
+	cat start.html toc.html middle.html api.html end.html \
+		| perl -pi -e "s/{VERSION}/$(VERSION)/g" > $@
+
+%.html: %.md
+	$(MARKED) $< > $@
+
+clean:
+	rm -f index.html toc.html api.html