Comments on: Codeview, a new template for JSDoc Toolkit

By: Wouter Bos

Wouter Bos — Wed, 14 Dec 2011 22:39:26 +0000

Thanks!

By: Romu

Romu — Wed, 14 Dec 2011 17:25:32 +0000

Looks great, love it, Amazing job

By: Wouter Bos

Wouter Bos — Sat, 30 Jul 2011 21:09:40 +0000

Code syntax coloring is not supported at the moment. The problem is that some people (well, me at least) do not just add JavaScript to the code example but also the accompanying HTML. I might build it into the template someday and make it optional.
I fixed the Google Chrome 10. The new Codeview is downloadable from Github: https://github.com/WouterBos/Codeview

…And sorry for the late reply…

By: gainover

gainover — Tue, 05 Apr 2011 16:48:26 +0000

Thanks for your template, I have applied it to my project.

By: Wouter Bos

Wouter Bos — Sun, 06 Mar 2011 09:59:28 +0000

Sorry, but I’m no good with that either. You’ll most likely get a sane answer at http://groups.google.com/group/jsdoc-2

By: Dave

Dave — Thu, 03 Mar 2011 18:46:54 +0000

Thanks for providing this- it looks great.

I have a longshot question for you about jsdoc. I’m trying to get the –exclude option working to exclude all js files that start with a certain string. The problem is I can seem to stumble upon the right regex expression to make this work. Any suggestions?

By: Benjamin

Benjamin — Thu, 03 Mar 2011 12:55:36 +0000

Ops, xml tags dissapeared,
- class in pre tags is :”code brush: js”
- the block of added references can be checked here (under “Syntax Highlighting” comment):
https://github.com/benjamine/tent/blob/master/jsdoc-toolkit/templates/codeview-syntaxhighlight/subtemplates/head.tmpl

By: Benjamin

Benjamin — Thu, 03 Mar 2011 12:52:02 +0000

(Sorry for the delay)

I publish the modified template at my javascript library project on GitHub, its here:

https://github.com/benjamine/tent/tree/master/jsdoc-toolkit/templates

there is a folder with the original codeview, and another named codeview-syntaxhighlight/

basically the changes a made are:

class.tmpl > modify class in all code examples this way:
{+example+}
——————–

foot.tmpl > add syntax highlighting init:
// Syntax Highlighting
SyntaxHighlighter.all();
————–

head.tmpl > add references to .js and .css files in this block:

—————-
Add the files referenced on head.tmpl:
css/shCore.css
css/shThemeDefault.css
javascript/shCore.js
javascript/shBrushJScript.js

Note: shThemeDefault.css can be replace to get some diferent styles, themes can be download from:
http://alexgorbatchev.com/SyntaxHighlighter/

As an example you can check this doc page I uploaded (there’s code at the bottom):

http://benjamine.github.com/tent/docs/api/symbols/tent.entities.Context.html

By: Wouter Bos

Wouter Bos — Sat, 19 Feb 2011 06:16:35 +0000

Thanks. I’ll look into this

By: Wouter Bos

Wouter Bos — Sat, 19 Feb 2011 06:16:17 +0000

Sounds great! I’d like to see your patch!