sutro-jsdoc-theme

Sutro

A clean, responsive, documentation template theme for JSDoc 3.

Based on Namis, which is based on based on Minami.

Uses

• Source Sans Pro and Source Code Pro typefaces by Adobe.
• the Taffy Database library
• Underscore Template library

Install

$ npm install --save-dev sutro-jsdoc-theme

Usage

$ jsdoc entry-file.js -t node_modules/sutro-jsdoc-theme

You can customize the template in your jsdoc.conf.json file:

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "include": "./src/",
        "includePattern": ".+\\.js$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "outputSourceFiles": true,
        "linenums": true,
        "includeDate": false,
        "title": "MathLive",
        "pageTitle": "MathLive Docs",
        "description": "Beautifully typeset math made easy",
        "keywords": "latex, tex, math, typesetting, documentation, docs",
        "forkme": "https://github.com/arnog/mathlive"
    },
    "opts": {
        "access": "all",
        "template": "node_modules/sutro-jsdoc-theme",
        "recurse": true,
        "destination": "./docs",
        "readme": "CONTRIBUTOR_GUIDE.md"
    }
}

The keys in the opts section are defined by JSDoc:

• access: only display symbols with the given access property: private, protected, public, undefined or all.
• recurse: when scanning for source files and tutorials, recurse directories.
• destination: path to the output folder for the generated documentation
• readme: the file to include in the generated documentation as the "home page"

The keys in the templates section are specific to Sutro:

• cleverLinks
• monospaceLinks
• outputSourceFiles: if true, include prettyfied source files in the documentation
• linenums: if true, include line numbers in prettyfied output
• sourceCodeTheme: the color scheme used for the prettyfied source code: dark or light
• sourceCodeBackground: a CSS background shorthand describing the background used to display source code. Defaults to dark or light color depending on sourceCodeTheme.
• includeDate: if true, include date of documentation creation in footer
• title: name of the "home" link, at the top left of the page
• pageTitle: value of the <title> tag
• description: value of the <description> tag
• keywords: value of the <keywords> tag
• forkme: if present, display a "Fork Me" banner, with a URL pointing to the value of this entry
• headerAddendum and bodyAddendum: if present the content will be inserted in the template in the header and just before end the end body tag, respectively. This can be useful to add additional scripts in the template.

License

Licensed under the Apache2 license.