# grunt-test-docbase

> Static HTML generetor plugin.

Latest version **0.0.4** (published 2016-03-27) · 0 weekly downloads

## Install

```sh
npm install grunt-test-docbase
pnpm add grunt-test-docbase
yarn add grunt-test-docbase
bun add grunt-test-docbase
```

## 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.0.4 |
| Published | 2016-03-27 |
| First published | 2016-03-26 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Farhan Chauhan |
| Maintainers | farhan687 |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-test-docbase
- Repository: https://github.com/farhan687/grunt-docbase
- Issues: https://github.com/farhan687/grunt-docbase/issues
- npm.io page: https://npm.io/package/grunt-test-docbase

## Dependencies (1)

- [phantom](https://npm.io/package/phantom.md) ^0.7.2

## Recent versions

- 0.0.4 (latest) — 2016-03-27
- 0.0.3 — 2016-03-26
- 0.0.2 — 2016-03-26
- 0.1.23 — 2016-03-26

## README

# grunt-docbase

> Grunt plugin to generate html files from your docbase project.

## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-docbase --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-docbase');
```

## The "docbase" task

### Overview
In your project's Gruntfile, add a section named `docbase` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  docbase: {
    options: {
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})
```

### Options

#### options.generatePath
Type: `String`
Default value: `html/`

A string value that is used to create the files generated.

#### options.urlToAcess
Type: `String`
Default value: `http://localhost:8080/`

A string value that will be crawled to generate the HTML files.

### Usage Examples

#### Default Options
In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`

```js
grunt.initConfig({
  docbase: {
    options: {
      generatePath: 'html/',
      urlToAcess: 'http://localhost:8080/',
    },
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
})
```


## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

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