Bootstrap Templates & Themes Logo Bootstrap Templates & Themes
Docstrap screenshot

Docstrap

Author Avatar Theme by Docstrap
Updated: 17 May 2019
761 Stars

A template for JSDoc3 based on Bootstrap and themed by Bootswatch

Github

Categories

Documentation Templates & themes

Overview:

DocStrap is a Bootstrap based template for JSDoc3 that provides a customizable and themed documentation solution. It includes all of the themes from Bootswatch, giving users a variety of options for the look and feel of their documentation. The template also offers a right side table of contents for easy navigation, an integrated offline search feature, and syntax highlighting.

Features:

  • Themed: DocStrap includes all of the themes from Bootswatch, giving users multiple options for the look and feel of their documentation.
  • Customizable: The template comes with a conf.json file that allows users to tweak the template to their specific needs. Options include setting the system name, adding a footer, including a copyright message, and choosing a theme.
  • Right side TOC: DocStrap provides a right side table of contents for easy navigation within pages.
  • Integrated offline search: Users can search for specific content within the documentation using the integrated offline search feature.
  • Syntax highlighting: DocStrap includes syntax highlighting for code snippets, making them easier to read and understand.

Installation:

To use DocStrap, follow these steps:

  1. If you manage your own version of jsdoc, you can use the grunt-jsdoc package along with DocStrap.
  2. Set the configuration in the conf.json file. This includes options such as the system name, footer, copyright message, theme, and more.
  3. Use the -t flag when running jsdoc to set the template to DocStrap.
  4. Use the -R flag to set a markdown file as the front page of the documentation.
  5. Use the -r flag to run jsdoc recursively.
  6. Run jsdoc from the current directory.

Here is an example command line usage:

jsdoc -c conf.json -t docstrap -R index.md -r .

Summary:

DocStrap is a Bootstrap based template for JSDoc3 that provides a customizable and themed documentation solution. With its integration of Bootswatch themes, right side TOC, integrated offline search, and syntax highlighting, DocStrap offers a user-friendly and visually appealing option for documenting code. Users can easily install and configure the template to meet their specific needs.