https://github.com/braintree/jsdoc-template

A clean, responsive documentation template with search and navigation highlighting for JSDoc 3
https://github.com/braintree/jsdoc-template

Last synced: 8 days ago
JSON representation

A clean, responsive documentation template with search and navigation highlighting for JSDoc 3

• Host: GitHub
• URL: https://github.com/braintree/jsdoc-template
• Owner: braintree
• License: other
• Created: 2016-05-26T17:37:00.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-09-06T15:17:47.000Z (about 1 year ago)
• Last Synced: 2024-09-18T23:15:07.697Z (about 2 months ago)
• Language: CSS
• Homepage:
• Size: 660 KB
• Stars: 176
• Watchers: 18
• Forks: 56
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Braintree JSDoc Template

A clean, responsive documentation template with search and navigation highlighting for JSDoc 3. Forked from [github.com/nijikokun/minami](https://github.com/nijikokun/minami).

![Braintree JS Doc Template Screenshot](https://puu.sh/rWvW0/2831fd69d6.png)

## Responsive

![Braintree JS Doc Template Screenshot](https://puu.sh/rWvZ6/aee92a4787.png)

## Uses

- [the Taffy Database library](http://taffydb.com/)

- [Underscore Template library](http://documentcloud.github.com/underscore/#template)

- [Algolia DocSearch](https://community.algolia.com/docsearch/)

## Usage

Clone repository to your designated `jsdoc` template directory, then:

### Node.js Dependency

In your projects `package.json` file add a generate script:

```json

"script": {

  "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"

}

```

In your `.jsdoc.json` file, add a template option.

```json

"opts": {

  "template": "node_modules/jsdoc-template"

}

```

### Example JSDoc Config

```json

{

    "tags": {

        "allowUnknownTags": true,

        "dictionaries": ["jsdoc"]

    },

    "source": {

        "include": ["lib", "package.json", "README.md"],

        "includePattern": ".js$",

        "excludePattern": "(node_modules/|docs)"

    },

    "plugins": [

        "plugins/markdown"

    ],

    "templates": {

        "referenceTitle": "My SDK Name",

        "disableSort": false,

        "collapse": true,

        "resources": {

            "google": "https://www.google.com/"

        }

    },

    "opts": {

        "destination": "./docs/",

        "encoding": "utf8",

        "private": true,

        "recurse": true,

        "template": "./node_modules/jsdoc-template"

    }

}

```

Note: `referenceTitle` and `disableSort` will affect the output of this theme.

If you would like to enable [Algolia DocSearch](https://community.algolia.com/docsearch/), you can pass a `search` object into the `templates` object.

```json

"templates": {

    "search": {

        "apiKey": "your-api-key",

        "indexName": "Your index name. Defaults to braintree.",

        "hitsPerPage": "Number of Results to show. Defaults to 7.",

    }

}

```

## License

Licensed under the Apache2 license.