# sutro-jsdoc-theme

> JSDoc theme based on Namis, based Minami

Latest version **1.1.0** (published 2019-02-05) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install sutro-jsdoc-theme
pnpm add sutro-jsdoc-theme
yarn add sutro-jsdoc-theme
bun add sutro-jsdoc-theme
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-02-05 |
| First published | 2018-03-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 472.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Arno Gourdol |
| Maintainers | arnog |
| Keywords | jsdocs, jsdoc, theme, template, themeable, clean, nice, search, engine, responsive |

## Links

- npm: https://www.npmjs.com/package/sutro-jsdoc-theme
- Repository: https://github.com/arnog/sutro-jsdoc-theme
- Homepage: https://github.com/arnog/sutro-jsdoc-theme#readme
- Issues: https://github.com/arnog/sutro-jsdoc-theme/issues
- npm.io page: https://npm.io/package/sutro-jsdoc-theme

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2019-02-05
- 0.0.1 — 2018-03-14

## README

# Sutro

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

Based on [Namis](https://github.com/hungluu2106/namis), which is based on
based on [Minami](https://github.com/Nijikokun/minami).

![Sutro Screenshot](assets/screenshots/screenshot-small.png)

## Uses

- Source Sans Pro and Source Code Pro typefaces by Adobe.
- [the Taffy Database library](http://taffydb.com/)
- [Underscore Template library](http://underscorejs.org)

## Install

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

## Usage

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

You can customize the template in your `jsdoc.conf.json` file:
```json
{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "include": "./src/",
        "includePattern": ".+\\.js$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "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": {
        "outputSourceFiles": true,
        "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"
- `outputSourceFiles`: if `true`, include prettyfied source files in

The  keys in the `templates` section are specific to Sutro:
- `cleverLinks` 
- `monospaceLinks`
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.

---
_Source: https://npm.io/package/sutro-jsdoc-theme · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._