open-index/open-npm huggingface dataset:
npm package: @leeyeh/jsdoc-rtd
Description: Readthedocs-style jsdoc template. Fork from TUI JSDoc template.
Latest version: 1.0.14

# jsdoc-rtd

## install
```
npm install jsdoc-rtd --save-dev
```

## about
A [readthedocs](http://read-the-docs.readthedocs.io/en/latest/getting_started.html) style jsdoc template. Forked from [TUI JSDoc Template](https://github.com/nhnent/tui.jsdoc-template) to inherit the extra
navigation and search features. Mobile navigation styling applied from [docdash template](https://github.com/clenemt/docdash). Cleaned up to SCSS and ES6.

* Styling - Based on the readthedocs theme
* Styling - Mobile-friendly version (Docdash)
* Navigation - AutoComplete Searchbox (TUI JSDoc)
* Navigation - Members / Methods / Events (TUI JSDoc)
* Navigation - API / Manuals(Tutorials) Tab (TUI JSDoc)

![Example](https://cloud.githubusercontent.com/assets/213060/23259167/0dd22ca4-f9cc-11e6-9d5e-3ed926c85296.png)

![Example](https://cloud.githubusercontent.com/assets/213060/23260127/a865491e-f9d0-11e6-8748-35b430d8c68a.png)


## Configuration
See the [jsdoc configuration page](http://usejsdoc.org/about-configuring-jsdoc.html#incorporating-command-line-options-into-the-configuration-file) for generic configaturion options.


### Template
```
"opts": {
    "template": "node_modules/jsdoc-rtd"
}
```

### Logo Image
```
"templates": {
    "logo": {
        "url": "http://url.to/image.png",
        "width": "72px",
        "height": "60px"
    }
}
```

### Page Title
```
"templates": {
    "name": "jsdoc template"
}
```

### FooterText
```
"templates": {
    "footerText": "some text"
}
```

### Use collapsible api list
*Default: `true`*
```
"templates": {
    "useCollapsibles": ture
}
```

### Tab Names
```
"templates": {
    "tabNames": {
        "api": "API",
        "tutorials": "Examples"
    }
}
```

`api` defaults to the value `API` and `tutorials` defaults to the value `Examples`.

### Custom Styles
With a folder structure like this:
```
static
└── styles
    └── custom.css
    └── another.css
```
And a config like this:
```js
"templates": {
    "default": {
        "staticFiles": {
            "include": ["static/"]
        }
    },
    "css": [
        "styles/custom.css",
        "styles/another.css",
        "http://example.com/remote.css"
    ]
}
```

`styles/custom.css`, `styles/another.css`, and `remote.css` get included in the layout.
`default.staticFiles` is the build-in jsdoc way of copying extra files.

<br>
## Expose the html/js code to example page
If `script` or `div` elements have `code-js` or `code-html` class, expose their innerHTML.

1. innerHTML of `script.code-js` tag
2. innerHTML of `div.code-html` tag

```
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>example</title>
</head>
<body>
    <div class="code-html">
        <h3> Base Example </h3>
        <p> Hello world </p>
    </div>

    <script class="code-js">
        console.log('hello world');
    </script>
</body>
</html>

```
npm package: @leeyeh/rollup-plugin-node-resolve
Description: Bundle third-party dependencies in node_modules
Author: Rich Harris
Latest version: 3.0.1

# rollup-plugin-node-resolve

*This plugin used to be called rollup-plugin-npm*

Locate modules using the [Node resolution algorithm](https://nodejs.org/api/modules.html#modules_all_together), for using third party modules in `node_modules`

## Installation

```bash
npm install --save-dev rollup-plugin-node-resolve
```

## Usage

```js
// rollup.config.js
import { rollup } from 'rollup';
import resolve from 'rollup-plugin-node-resolve';

export default {
  entry: 'main.js',
  dest: 'bundle.js',
  moduleName: 'MyModule',
  format: 'iife'
  plugins: [
    resolve({
      // use "module" field for ES6 module if possible
      module: true, // Default: true

      // use "jsnext:main" if possible
      // – see https://github.com/rollup/rollup/wiki/jsnext:main
      jsnext: true,  // Default: false

      // use "main" field or index.js, even if it's not an ES6 module
      // (needs to be converted from CommonJS to ES6
      // – see https://github.com/rollup/rollup-plugin-commonjs
      main: true,  // Default: true

      // some package.json files have a `browser` field which
      // specifies alternative files to load for people bundling
      // for the browser. If that's you, use this option, otherwise
      // pkg.browser will be ignored
      browser: true,  // Default: false

      // not all files you want to resolve are .js files
      extensions: [ '.js', '.json' ],  // Default: ['.js']

      // whether to prefer built-in modules (e.g. `fs`, `path`) or
      // local ones with the same names
      preferBuiltins: false,  // Default: true

      // Lock the module search in this path (like a chroot). Module defined
      // outside this path will be mark has external
      jail: '/my/jail/path', // Default: '/'

      // If true, inspect resolved files to check that they are
      // ES2015 modules
      modulesOnly: true, // Default: false

      // Any additional options that should be passed through
      // to node-resolve
      customResolveOptions: {
        moduleDirectory: 'js_modules'
      }
    })
  ]
};
```

## Using with rollup-plugin-commonjs

Since most packages in your node_modules folder are probably legacy CommonJS rather than JavaScript modules, you may need to use [rollup-plugin-commonjs](https://github.com/rollup/rollup-plugin-commonjs):

```js
// rollup.config.js
import { rollup } from 'rollup';
import resolve from 'rollup-plugin-node-resolve';
import commonjs from 'rollup-plugin-commonjs';

export default {
  entry: 'main.js',
  dest: 'bundle.js',
  moduleName: 'MyModule',
  format: 'iife'
  plugins: [
    resolve({ jsnext: true, main: true }),
    commonjs()
  ]
};
```


## License

MIT