https://github.com/ivansanchez/gobble-markdown-styles

Transform MarkDown files to HTML in your GobbleJS workflow
https://github.com/ivansanchez/gobble-markdown-styles

Last synced: 28 days ago
JSON representation

Transform MarkDown files to HTML in your GobbleJS workflow

• Host: GitHub
• URL: https://github.com/ivansanchez/gobble-markdown-styles
• Owner: IvanSanchez
• Created: 2016-02-22T15:31:33.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-10-10T09:13:46.000Z (about 8 years ago)
• Last Synced: 2024-10-14T15:36:07.241Z (2 months ago)
• Language: JavaScript
• Size: 1000 Bytes
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gobble-markdown-styles

Transform MarkDown files to HTML in your GobbleJS workflow

## Installation

I assume you already know the basics of [Gobble](https://github.com/gobblejs/gobble).

```bash

npm i -D gobble-markdown-styles

```

## Usage

In your `gobblefile`, run the `markdown-styles` gobble transform, like so:

```javascript

var gobble = require( 'gobble' );

module.exports = gobble( 'src' ).transform( 'markdown-styles', {

	layout: 'github'

});

```

That transform will create a `.html` file for every `.md` file.

Note that the transform needs a `layout` option to specify the layout and style

to use. The layout can be a string specifying a built-in layout, or a path

to a layout directory. See the [`markdown-styles` documentation](https://github.com/mixu/markdown-styles)

for details.

## License

```

"THE BEER-WARE LICENSE":

 wrote this file. As long as you retain this notice you

can do whatever you want with this stuff. If we meet some day, and you think

this stuff is worth it, you can buy me a beer in return.

```