Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

jsdoc template option #19

Closed
codeBelt opened this issue Feb 24, 2013 · 2 comments
Closed

jsdoc template option #19

codeBelt opened this issue Feb 24, 2013 · 2 comments
Assignees
@krampstudio
Milestone
v0.2.4

Comments

@codeBelt
Copy link

It would be nice to set different templates in the options. I want to use the (http://orgachem.github.com/JsDoc2-Template-Bootstrap/) template.

jsdoc : {
            options: {
                template: 'bootstrap'
            },
            dist : {
                src: ['lib/app.js'],
                dest: 'doc'
            }
        }

Not sure if this would be the best way but the easiest way would be to put the template files in: {Project Folder}/node_modules/grunt-jsdoc/node_modules/jsdoc/templates/bootstrap
@ghost ghost assigned krampstudio Feb 24, 2013
@krampstudio
Copy link
Owner

I'll enable to add most of the supported options described on the jsdoc doc including the templates.
But the template you referr as seems to be jsdoc2 only compatible, I don't know if it will work with jsdoc3.

gknobloch added a commit to gknobloch/grunt-jsdoc-plugin that referenced this issue Mar 1, 2013
@gknobloch
krampstudio#19 - jsdoc template option
d1ba3c7 
* Refactored code to support JSDoc command line options
* Still supporting old syntax for providing JSDoc destination through 'dest' key
@krampstudio
Copy link
Owner

The template option works fine now (thanks to @gknob ), but as expected, the bootstrap template isn't compatible with jsdoc3 and produce the following output
I guess the amount of work to make the template jsdoc3 compatible isn't too musch huge.

krampstudio added a commit that referenced this issue Mar 1, 2013
@krampstudio
Fix #19 by enabling to set manually the jsdoc path
02ebad1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@krampstudio krampstudio

Labels
None yet
Projects
None yet
Milestone
v0.2.4
Development

No branches or pull requests
2 participants
@krampstudio @codeBelt