New JSDoc3 Template

[Terry]

DocStrap is Bootstrap based template for JSDoc3. In addition, it includes all of the themes from Bootswatch giving you a great deal of look and feel options for your documentation. Additionally, it adds some options to the conf.json file that gives you even more flexibility to tweak the template to your needs. 

Grab it at https://github.com/terryweiss/docstrap

The template features fixed navigation at page top with right side TOC for in-page navigation. 

Here are examples of this template with the different Bootswatch themes:

• Amelia
• Cerulean
• Cosmo
• Cyborg
• Flatly
• Journal
• Readable
• Simplex
• Slate
• Spacelab
• Spruce
• Superhero
• United

To change your theme, just change it in the conf.json file. See below for details.

DocStrap ships with a conf.json file in the template/ directory. It is just a regular old JSDoc configuration file, but with the following new options:

• systemName The name of the system being documented. This will appear in the page title for each page
• footer Any markup want to appear in the footer of each page. This is not processed at all, just printed exactly as you enter it
• copyright You can add a copyright message below the footer and above the JSDoc timestamp at the bottom of the page
• navType The template uses top level navigation with dropdowns for the contents of each category. On large systems these dropdowns can get large enough to expand beyond the page. To make the dropdowns render wider and stack the entries vertically, set this option to "inline". Otherwise set it to "vertical" to make them regular stacked dropdowns.
• theme This is the name of the them you want to use in all lowercase. The valid options are
  • amelia
  • cerulean
  • cosmo
  • cyborg
  • flatly
  • journal
  • readable
  • simplex
  • slate
  • spacelab
  • spruce
  • superhero
  • united
• linenums When true, line numbers will appear in the source code listing. If you have also turned that on.
• collapseSymbols If your pages have a large number of symbols, it can be easy to get lost in all the text. If you turn this to true all of the symbols in the page will roll their contents up so that you just get a list of symbols that can be expanded and collapsed.
• inverseNav Bootstrap navbars come in two flavors, regular and inverse where inverse is generally higher contrast. Set this to true to use the inverse header.

See the full docs out at github. I hope this helps someone out! Let me know if you run into problems.

Cheers,

t.

[Mads Bondo Dydensborg]

Very nice!

 

Thanks a lot

 

Mads

--
You received this message because you are subscribed to the Google Groups "JSDoc Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jsdoc-users...@googlegroups.com.
To post to this group, send email to jsdoc...@googlegroups.com.
Visit this group at http://groups.google.com/group/jsdoc-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

--

Med venlig hilsen/Regards

 

Chefarkitekt/Chief Architect cand.scient.dat, Ph.d., Mads Bondo Dydensborg

Dansk BiblioteksCenter A/S, Tempovej 7-11, 2750 Ballerup, Tlf. +45 29 84 00 42

 

[Michael]

Terry,

Oh dear. I think I've got a little "developer crush" going on for your project...

Beautiful stuff. Thanks for sharing.

--

Michael

--

[Raghavendra Iyer]

Thanks! This is a sweet looking template.