Skip to content

Commit

Permalink
Restructured documentation into Markdown format
Browse files Browse the repository at this point in the history
This commit restructures the documenation into Markdown instead of
LaTeX. More people are familiar with Markdown, and those that aren't
can pick it up quickly. That should help promote more contributions
to the project.
  • Loading branch information
jsumners committed Dec 7, 2014
1 parent e86968e commit bdadfdb
Show file tree
Hide file tree
Showing 49 changed files with 1,083 additions and 10,539 deletions.
9 changes: 3 additions & 6 deletions .gitignore
@@ -1,10 +1,7 @@
*.sublime-workspace
node_modules/
target/
doc/html/*.html
doc/html/*.jpg

*.zip
tex/*.pdf
tex/*.aux
tex/*.log
tex/*.rai
tex/*.toc
*.zip
40 changes: 35 additions & 5 deletions Gruntfile.js
Expand Up @@ -6,24 +6,54 @@ var packageJSON = require('./package.json');
require('load-grunt-tasks')(grunt);

grunt.initConfig({
panda: {
docSite: {
options: {
pandocOptions: '-t html5 --section-divs --mathjax -s'
},
files: [{
expand: true,
flatten: true,
src: './doc/src/*.md',
dest: './doc/html/',
ext: '.html'
}]
},
pdf: {
options: {
pandocOptions: '-t latex --smart'
},
files: [{
expand: true,
cwd: './doc/src/',
src: 'Index.md',
dest: 'target/',
ext: '.pdf'
}]
}
},

shell: {
genPDF: {
command: 'cd tex && pdflatex main.tex && mv main.pdf doc.pdf'
copyDiagramToSite: {
command: 'cp ./doc/src/visual.jpg ./doc/html/'
},

prepareRelease: {
command: 'rm -rf target *.zip && mkdir target && ' +
'cp -R src/* testsuite examples tex/doc.pdf *install.sql change.log readme.txt target'
'cp -R src/* testsuite examples *install.sql change.log readme.txt target && ' +
'cp -R doc/html target/doc/'
}
},

zip : {
'using-cwd': {
cwd: 'target/',
src: ['target/*'],
src: ['target/**'],
dest: 'release-' + packageJSON.version + '.zip'
}
}
});

grunt.registerTask('release', ['shell:genPDF', 'shell:prepareRelease', 'zip']);
grunt.registerTask('release', ['panda:docSite', 'shell:prepareRelease', 'zip']);
grunt.registerTask('buildDocSite', ['panda:docSite', 'shell:copyDiagramToSite']);
grunt.registerTask('buildPDF', ['panda:pdf']);
Empty file added doc/html/.gitkeep
Empty file.

0 comments on commit bdadfdb

Please sign in to comment.