# docdash-with-search

> A clean, responsive documentation template theme for JSDoc 3 with search based on docdash.

Latest version **0.1.4** (published 2018-08-09) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install docdash-with-search
pnpm add docdash-with-search
yarn add docdash-with-search
bun add docdash-with-search
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2018-08-09 |
| First published | 2018-08-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 521 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Hal Zhan |
| Maintainers | halzhan |
| Keywords | jsdoc, docdash, template, search |

## Links

- npm: https://www.npmjs.com/package/docdash-with-search
- Repository: https://github.com/HalZhan/docdash-with-search
- Homepage: https://github.com/HalZhan/docdash-with-search#readme
- Issues: https://github.com/HalZhan/docdash-with-search/issues
- npm.io page: https://npm.io/package/docdash-with-search

## 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

- 0.1.4 (latest) — 2018-08-09
- 0.1.3 — 2018-08-08
- 0.1.2 — 2018-08-08
- 0.1.1 — 2018-08-08
- 0.1.0 — 2018-08-08
- 0.0.2 — 2018-08-07
- 0.0.1 — 2018-08-07

## README

# docdash-with-search
[![npm package](https://img.shields.io/npm/v/docdash-with-search.svg)](https://www.npmjs.com/package/docdash-with-search) [![license](https://img.shields.io/npm/l/docdash-with-search.svg)](LICENSE.md)

A clean, responsive documentation template theme with search for JSDoc 3 based on [`Docdash`](https://github.com/clenemt/docdash).

![docdash-screenshot-overview](http://halzhan.cn/docdash-with-search/overview.png)

![docdash-screenshot-with-search](http://halzhan.cn/docdash-with-search/overview_search.png)

## Example
See http://halzhan.cn/docdash-with-search/ for a sample demo. :rocket:

## Install

```bash
$ npm install docdash-with-search
```

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

```bash
$ jsdoc entry-file.js -t path/to/docdash-with-search
```

or

```bash
$ jsdoc -c jsdoc.conf.json -t path/to/docdash-with-search
```

## Usage (npm)
In your projects `package.json` file add a new script:

```json
"script": {
  "generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}
```

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

```json
"opts": {
  "template": "node_modules/docdash-with-search"
}
```

## Sample `jsdoc.conf.json`
See the config file for the [fixtures](fixtures/fixtures.conf.json) or the sample below.

```json
{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "include": [
            "fixtures/",
            "./README.md"
        ]
    },
    "plugins": ["plugins/markdown"],
    "opts": {
        "encoding": "utf8",
        "template": "./",
        "destination": "../fixtures-doc/",
        "recurse": true,
        "verbose": true
    },
    "markdown": {
        "parser": "gfm",
        "hardwrap": true
    },
    "templates": {
        "search": true,
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": true,
            "includeDate": false
        },
        "scripts": [],
        "favicon": "",
        "css": []
    },
    "docdash": {
        "static": false,
        "sort": true
    }
}
```

## Options
Docdash supports the following options:

```
{
    "docdash": {
        "static": [false|true],  // Display the static members inside the navbar.
        "sort": [false|true]     // Sort the methods in the navbar.
    },
    "templates": {
        "search": [false|true], // Display the search input element inside the navbar.
        "scripts": [], // Script files' URLs will be added to the html files orderly with script elements.
        "favicon": "", // The favicon's URL.
        "css": [] // Css files' URLs will be added be added to the html files orderly with link elements.
    }
}
```

Place them anywhere inside your `jsdoc.json` file.

## Change Logs
### v0.1.4(2018/08/09)
- Optimized the search function.

### v0.1.3(2018/08/08)
- Bugfix.

### v0.1.2(2018/08/08)
- Bugfix.

### v0.1.1(2018/08/08)
- Optimized the link elements' click event.

### v0.1.0(2018/08/08)
- Added supports for searching by comment or name.
- Added auto-complete function to the input element.

### v0.0.2(2018/08/07)
First version.

## License
Licensed under the Apache License, version 2.0. (see [Apache-2.0](LICENSE.md)).

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