angular-jsdoc icon indicating copy to clipboard operation
angular-jsdoc copied to clipboard

Template and bootstrap?

Open reloaded opened this issue 9 years ago • 3 comments

It would be beneficial to integrate Bootstrap into the templates to help with style consistencies and provide access to some elegant Bootstrap features.

Anyone have any thoughts on this or oppositions?

reloaded avatar Apr 19 '16 22:04 reloaded

Hmm… I think this might be oversized for just generating documentation. Bootstrap is quite big for this purpose.

Zemke avatar Apr 21 '16 20:04 Zemke

You could always select the minimum bootstrap components that are needed. Nothing wrong with leaving out the 70% of bootstrap that will never be used.

I will like to customize the overall theme of the documentation without straying away from the official default template provided in angular-jsdoc because if a doc tag support update is released I have to update my copy of the template to leverage it.

Here's a thought I've had for the last couple days. What if the CSS class names in the default template follow the class names of Bootstrap. Maybe you guys use a trimmed down version of Bootstrap or maybe you custom roll the CSS. If the CSS class names follow bootstrap class names then you could open up a plugin option/setting to allow users to inject custom

elements (like script and link tags). That way users can inject their own styles into the templates to override the default CSS that's provided out of the box.

Any thoughts on this?

reloaded avatar Apr 21 '16 23:04 reloaded

It's good to have bootstrap CSS supported, but not officially though.

I would like to have a separate full template PR from who is interested in maintaining a bootstrap template.

In that case I would like to use CDN CSS instead of internal one.

allenhwkim avatar Apr 22 '16 00:04 allenhwkim