metalsmith-metallic/Readme.md

A Metalsmith plugin to hightlight code blocks in markdown using highlight.js.

# metalsmith-metallic [![travis status](https://travis-ci.org/weswigham/metalsmith-metallic.svg)](https://travis-ci.org/weswigham/metalsmith-metallic) [![npm version](https://badge.fury.io/js/metalsmith-metallic.svg)](https://www.npmjs.com/package/metalsmith-metallic)

  A [Metalsmith](http://metalsmith.io) plugin to highlight code in Markdown files.

## Installation

    $ npm install metalsmith-metallic
    
## Setup

Include a [highlight.js](http://highlightjs.org/download/) theme somewhere in your templates.

Ex:
```html
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/styles/default.min.css">
```

## CLI Usage

  Install via npm and then add the `metalsmith-metallic` key to your `metalsmith.json` plugin, like so:

```json
{
  "plugins": {
    "metalsmith-metallic": true
  } 
}
```

## Javascript Usage

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

metalsmith.use(metallic());
```

## License

  MIT