# markdown-templator
Include markdown files in an HTML template

## Installation
```sh
$ npm install markdown-templator
```

## Documentation
## `Templator(options)`
Creates a new `Templator` instance.

### Params
- **Object** `options`: An object containing the following fields:
 - `path` (String): The path to look for markdown partials.

## `processFile(templateFile)`
Run the contents of an HTML file through the `Templator`

### Params
- **String** `templateFile`: Path to HTML file to be processed

### Return
- **String** The processed HTML

## `processContent(templateContent)`
Inject markdown partials into HTML template

### Params
- **String** `templateContent`: HTML template string

### Return
- **String** The processed HTML



## How to contribute

1. File an issue in the repository, using the bug tracker, describing the
   contribution you'd like to make. This will help us to get you started on the
   right foot.
2. Fork the project in your account and create a new branch:
   `your-great-feature`.
3. Commit your changes in that branch.
4. Open a pull request, and reference the initial issue in the pull request
   message.

## License
See the [LICENSE](./LICENSE) file.

# markdown-templator
Include markdown files in an HTML template. [gulp-md-template](https://github.com/grit96/gulp-md-template) is a Gulp plugin for this with example usage.

## Installation
```sh
$ npm install markdown-templator
```

## Documentation
## `Templator(options)`
Creates a new `Templator` instance.

### Params
- **Object** `options`: An object containing the following fields:
 - `path` (String): The path to look for markdown partials.

## `processFile(templateFile)`
Run the contents of an HTML file through the `Templator`

### Params
- **String** `templateFile`: Path to HTML file to be processed

### Return
- **String** The processed HTML

## `processContent(templateContent)`
Inject markdown partials into HTML template

### Params
- **String** `templateContent`: HTML template string

### Return
- **String** The processed HTML



## How to contribute

1. File an issue in the repository, using the bug tracker, describing the
   contribution you'd like to make. This will help us to get you started on the
   right foot.
2. Fork the project in your account and create a new branch:
   `your-great-feature`.
3. Commit your changes in that branch.
4. Open a pull request, and reference the initial issue in the pull request
   message.

## License
See the [LICENSE](./LICENSE) file.

Add link to gulp plugin
Add link to gulp plugin
