TODO: Besides splitting this out from previous commit, should really avoid markdown field in favor of modifying jsdoc to report wherever it lays out "prettyprint"; still probably missing some one-liners; see https://github.com/google/code-prettify; update builds to confirm new stackblur is working; add below to CHANGES; add back for eslint-plugin-jsdoc once merged (though need new version ^3.9.1); move any linting changes to other linting branch

- Refactoring (minor): Add favicon to canvas demo
- Linting (ESLint Markdown JavaScript): Add `eslint-plugin-markdown` with
  slightly loosened config (`no-undef` and `padded-blocks` off and
  `no-unused-vars` as a warning)
- Linting (ESLint JSDoc code comments): Add `eslint-plugin-jsdoc` and apply to
    JSDoc code comments
- Linting (ESLint): Completely avoid unescaped tabs in files
- Docs (Linting): Add linting info file
- npm: Rename `copy-deps` script to `copy`
- Refactoring: Add stackblur-canvas as a dependency and copy it in (until such time as we can do so for canvg)
This commit is contained in:
Brett Zamir
2018-10-31 03:41:22 +08:00
parent afa5576ed1
commit 901c9547fe
17 changed files with 413 additions and 327 deletions

View File

@@ -4,6 +4,8 @@
module.exports = {
plugins: ['plugins/markdown'],
markdown: {
// tags: ['examples']
/*
// "The highlighter function should escape the code block's contents and wrap them in <pre><code> tags"
highlight (code, language) {
function ret () {
@@ -11,6 +13,8 @@ module.exports = {
return '<pre><code>' + code + ' in this language: ' + language + '</code></pre>';
}
if (language !== 'js') { // E.g., we have one URL in some tutorial Markdown
// Seems to be only for full triple-backticked fences
// console.log('lll', code);
return ret();
}
@@ -48,8 +52,8 @@ module.exports = {
console.log('\n' + code);
return ret();
},
tags: []
}
*/
},
recurseDepth: 10,
source: {
@@ -69,15 +73,15 @@ module.exports = {
},
templates: {
cleverLinks: true,
monospaceLinks: false,
monospaceLinks: false /* ,
default: {
layoutFile: 'docs/layout.tmpl'
}
} */
},
opts: {
recurse: true,
verbose: true,
destination: 'docs/jsdoc',
// destination: 'docs/jsdoc',
tutorials: 'docs/tutorials'
}
};