Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ndhoule/metalsmith-asciidoc

A Metalsmith plugin to convert asciidoc files.
https://github.com/ndhoule/metalsmith-asciidoc

Last synced: 13 days ago
JSON representation

A Metalsmith plugin to convert asciidoc files.

Awesome Lists containing this project

README

        

# metalsmith-asciidoc

A Metalsmith plugin to convert asciidoc files.

###### Build Status

Branch | Status | Build Dependencies
--- | --- | ---
master | ![Master](https://travis-ci.org/ndhoule/metalsmith-asciidoc.svg?branch=master) | ![Master Dependencies](https://david-dm.org/ndhoule/metalsmith-asciidoc.svg?style=flat)

## Installation

```sh
$ npm install metalsmith-asciidoc
```

## CLI Usage

Install via `npm`, then add `metalsmith-asciidoc` key to your `metalsmith.json` plugins section:

```json
{
"plugins": {
"metalsmith-asciidoc": {}
}
}
```

## API Usage

Install via `npm` and require `metalsmith-asciidoc`, then pass to Metalsmith using the `use` method:

```js
var asciidoc = require('metalsmith-asciidoc');

metalsmith.use(asciidoc());
```

## Development

Clone the repo and install dependencies:

```sh
git clone https://github.com/ndhoule/metalsmith-asciidoc.git
npm install
```

Running tests:

```sh
make test
```

## License

Code copyright 2014 [Nathan Houle](mailto:[email protected]). Released under the [MIT license](LICENSE.md).