Merge pull request #57 from tsloughter/3.1.0

version bump to 3.1.0 and additions to docs

Author: tsloughter

.gitignore

@@ -1,3 +1,5 @@
+doc/*.html
+!doc/tpl.html
 _build
 deps/**
 ebin/**

doc/Makefile

@@ -0,0 +1,21 @@
+SOURCE_DOCS := $(wildcard *.md)
+
+EXPORTED_DOCS=\
+ $(SOURCE_DOCS:.md=.html)
+
+RM=/bin/rm
+
+PANDOC=pandoc
+
+PANDOC_HTML_OPTIONS=--standalone --highlight-style=tango --template tpl.html -f gfm --to html5
+
+%.html : %.md
+	$(PANDOC) $(PANDOC_HTML_OPTIONS) -o $@ $<
+
+
+.PHONY: all clean
+
+all : $(EXPORTED_DOCS)
+
+clean:
+	- $(RM) -f $(EXPORTED_DOCS)

doc/build.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+cd $(dirname $(realpath $0))
+
+make clean
+make
+
+# fix internal doc links
+sed -i 's/https:\/\/github\.com\/doc\/\([a-zA-Z_-]*\)\.md/\1.html/g' *.html
+sed -i 's/\"\([a-zA-Z_-]*\)\.md\([a-zA-Z_-#]*\)\"/\"\1.html\2\"/g' *.html
+sed -i 's/\"doc\/\([a-zA-Z_-]*\)\.md\"/\"\1.html\"/g' *.html
+sed -i 's/\"\([a-zA-Z_-]*\)\.md\"/\"\1.html\"/g' *.html
+
+# fix external doc links
+sed -i 's/maps\.html\#/http:\/\/erlang.org\/doc\/man\/maps\.html#/g' *.html
+sed -i 's/unicode\.html\#/http:\/\/erlang.org\/doc\/man\/unicode\.html#/g' *.html
+sed -i 's/maps\.md\#/http:\/\/erlang.org\/doc\/man\/maps\.html#/g' *.html
+sed -i 's/unicode\.md\#/http:\/\/erlang.org\/doc\/man\/unicode\.html#/g' *.html
+
+# cleans up the indentation of code blocks
+sed -i 's/      <a/<a/g' index.html