https://github.com/appbaseio/grunt-docbase
Grunt plugin to generate html files from your docbase project.
https://github.com/appbaseio/grunt-docbase
Last synced: about 1 year ago
JSON representation
Grunt plugin to generate html files from your docbase project.
- Host: GitHub
- URL: https://github.com/appbaseio/grunt-docbase
- Owner: appbaseio
- License: mit
- Created: 2015-07-21T03:53:38.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-02-03T07:16:35.000Z (over 9 years ago)
- Last Synced: 2025-06-19T03:06:40.995Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 2
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
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)_