@asciidoctor-extender/adoc-ext-include-markdown/README.md

An asciidoctor.js extension for markdown inclusion. (plugin for asciidoctor.js-extender)

# Markdown include plugin for asciidoctor-extender
> **Important notice:**
> This is a plugin for the 
> [asciidoctor.js-extender](https://www.npmjs.com/package/@asciidoctor-extender/asciidoctor.js-extender) project.

If you wish to [submit a bug](#registering-issues), [contribute](#contributing) or 
[request a feature](#requesting-new-features) please follow the guides at the end of this document.

## Installation
To include the library in your project run the following command:
```
npm install -S @asciidoctor-extender/adoc-ext-include-markdown
```

## Configuration
In order to use the plugin with the asciidoctor.js-extender project add the plugin to the configuration:
```javascript
{
  "extensions": {
    "include": [
      "@asciidoctor-extender/adoc-ext-include-markdown",
      ...
    ]
  },
  ...
}

```

# Registering issues
Should something be awry please feel free to register a bug by creating an issue labeled "bug" with a clear description 
of what fails, what is expected and steps to reproduce the error.

# Contributing
To contribute to this library you can fork the library, implement the feature and create a pull request. Then create an 
issue labeled "Contribution" with a clear description of the feature and a reference to the pull request.

# Requesting new features
In order to request a new feature please open a new issue labeled "Feature request" and a clear description of
the functionality that is requested.