diff --git a/.gitignore b/.gitignore
index c03d4034..ab81b2cb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,3 +13,4 @@
/node_modules
/dist
/.vs
+/web/docs/
\ No newline at end of file
diff --git a/Gruntfile.js b/Gruntfile.js
index 97d762a1..caa28acc 100644
--- a/Gruntfile.js
+++ b/Gruntfile.js
@@ -3,10 +3,14 @@ const webpack = require('webpack');
const webpackConfig = require('./webpack.config');
const del = require('del');
const libAssets = require("./build/libAssets");
+const glob = require("glob");
+const marked = require("marked");
+const Handlebars = require("handlebars");
const exec = require('child_process').exec;
module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-copy');
+ grunt.loadNpmTasks('grunt-contrib-watch');
function dirFilter(dirsToFilter) {
return (path) => {
@@ -19,7 +23,14 @@ module.exports = function(grunt) {
}
}
+ let DOCS_PATTERN = '*/features/*/docs/**';
grunt.initConfig({
+ watch: {
+ docs: {
+ files: ['modules/workbenches/' + DOCS_PATTERN],
+ tasks: ['gen-docs']
+ }
+ },
copy: {
@@ -38,8 +49,14 @@ module.exports = function(grunt) {
src: '**',
dest: 'dist/',
filter: dirFilter(['web/app', 'web/test'])
- }
+ },
+ docs: {
+ cwd: 'modules/workbenches',
+ src: DOCS_PATTERN,
+ dest: 'web/docs',
+ expand: true
+ },
}
});
@@ -72,6 +89,69 @@ module.exports = function(grunt) {
done(err);
});
});
-
+
grunt.registerTask('default', ['clean', 'build', 'copy:resources', 'copy:lib_assets', 'mark-revision', 'show-revision']);
-};
\ No newline at end of file
+
+ grunt.registerTask('gen-docs', ['copy:docs', 'process-markdown']);
+
+ grunt.registerTask('process-markdown', function() {
+ const done = this.async();
+
+ const mainTemplate = Handlebars.compile(grunt.file.read("modules/doc/doc-layout.handlebars"));
+
+ glob("web/docs/**/*.md", function (er, files) {
+
+
+ const workbenches = new Map();
+ files.forEach(file => {
+
+ const parts = file.split('/');
+
+ const workbenchName = parts[2];
+ const operationName = parts[4];
+ let workbench = workbenches.get(workbenchName);
+ if (!workbench) {
+ workbench = {
+ workbenchName,
+ operations: []
+ };
+ workbenches.set(workbenchName, workbench);
+ }
+ workbench.operations.push({
+ operationName,
+ href: '../../../../../../' + convertMdPathToHtml(file)
+ });
+ });
+
+ const sidenav = Array.from(workbenches.values());
+
+ files.forEach(file => {
+
+ const content = grunt.file.read(file);
+ const dest = convertMdPathToHtml(file);
+
+ const htmlContent = mainTemplate({
+ sidenav,
+ content: fixLinks(marked(content))
+ });
+
+ grunt.file.write(dest, htmlContent);
+
+ console.log("generated "+ dest);
+ })
+ done();
+ });
+ });
+
+ grunt.registerTask('docs-start', ['gen-docs', 'watch:docs']);
+};
+
+function convertMdPathToHtml(mdPath) {
+ return mdPath.substring(0, mdPath.length-('.md'.length)) + '.html';
+}
+
+function fixLinks(htmlContent) {
+ return htmlContent.replace(/href=['"](.+)['"]/g, function(expr, link){
+ return 'href="' + convertMdPathToHtml(link) + '"';
+ });
+}
\ No newline at end of file
diff --git a/modules/doc/doc-layout.handlebars b/modules/doc/doc-layout.handlebars
new file mode 100644
index 00000000..85545d52
--- /dev/null
+++ b/modules/doc/doc-layout.handlebars
@@ -0,0 +1,75 @@
+
+
+ Web CAD Documentation
+
+
+
+
+
+
+
+
+
+
+ {{#each sidenav}}
+
{{workbenchName}}
+
+ {{/each}}
+
+
+ {{{content}}}
+
+
+