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.

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

Barebone template #377

Closed
arcanis opened this issue Apr 1, 2013 · 3 comments
Closed

Barebone template #377

arcanis opened this issue Apr 1, 2013 · 3 comments
Labels
Milestone

Comments

@arcanis
Copy link
Contributor

arcanis commented Apr 1, 2013

I really like JSDoc, but I have to say that I'm a bit reluctant to write custom JSDoc templates for my projects for three reasons :

  • Possible BC changes later
  • A lot of code unrelated to the base project
  • Related to the previous issue, should I distribute the template as a dependency of my project ? Or ask users to download it ? Either case, it's not really convenient.

I would like to suggest another way which could make everyone happy without too much work : a css theming, based on the same concept than csszengarden : a single barebone template can be almost fully customized using only CSS rules. [it's also the same concept which is used by Reddit to customize subreddits]

No javascript, only standard class-heavy html files linked to a stylesheet (which could be specified as a command line option, it could for example be possible to imagine that using -t foo.css would use the barebone template, setting its stylesheet path to foo.css), ready to ship.

It would allow easy to maintain templates with a very few LoCs, which could be embed into project repositories without trouble.

What do you think about it ? I feel like it would be a very nice feature for many projects.

@hegemonic
Copy link
Contributor

I agree that something like this would be very useful. I think it's also essential to allow content overrides, not just style overrides. If you want to add method summaries, or new headings, or a cool navigation widget, or what have you, it shouldn't be necessary to fork the entire template.

In fact, I'm already working on a base JSDoc template that can be extended much more cleanly than the current template. This won't replace the default template, but I think it will provide a stronger foundation for anyone who wants to create a custom template.

I'll keep this feature request open until I get my project out the door (or until someone else beats me to it).

@okcoker
Copy link

okcoker commented Jun 20, 2013

👍 for this feature.

@hegemonic
Copy link
Contributor

The new Baseline template is now available and, in the not-too-distant future, will be easy to customize without forking the entire template.

Also, the default template now allows you to pull in additional CSS files by adding a config setting. See #480.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants