assemble-contrib-markdown

Convert markdown files to HTML, this is an alternative to the markdown Handlebars helpers. Both are useful in different scenarios.

npm install assemble-contrib-markdown
8 downloads in the last week
16 downloads in the last month

assemble-contrib-markdown NPM version

Convert markdown files to HTML, this is an alternative to the markdown Handlebars helpers. Both are useful in different scenarios.

Quickstart

In the command line, run:

npm install assemble-contrib-markdown --save

Next, register the plugin with Assemble in your project's Gruntfile:

assemble: {
  options: {
    plugin: ['assemble-contrib-markdown', 'other/plugins/*']
  }
}

Configuration

You can also use the plugin with specific targets:

assemble: {
  foo: {
    options: {
      plugin: ['assemble-contrib-markdown'],
      layout: 'blog-post.hbs'
    },
    files: {'dist/': 'content/*.md'}
  },
  // The plugin won't run on this target
  bar: {
    files: {'dist/': 'templates/*.hbs'}
  }
}

To disable the plugin, either remove it from the options or specify markdown: {convert: false} in the options:

assemble: {
  foo: {
    options: {
      plugin: ['assemble-contrib-markdown'],
      markdown: {convert: false}
    },
    files: {'dist/': 'content/*.md'}
  }
}

Visit the plugins docs for more info or for help getting started.

You might also be interested in these other plugins from the Assemble core team:

assemble-contrib-anchors NPM version

Assemble plugin for creating anchor tags from generated html.

assemble-contrib-contextual NPM version

Generates a JSON file containing the context of each page. Basic plugin to help see what's happening in the build.

Permalinks plugin for Assemble, the static site generator for Grunt.js and Yeoman. This plugin enables powerful and configurable URI replacement patterns, presets, uses Moment.js for parsing dates, and much more.

assemble-contrib-rss NPM version

Plugin for creating RSS feeds with Assemble, the static site generator for Node.js, Grunt.js and Yeoman.

assemble-contrib-sitemap NPM version

Sitemap generator plugin for Assemble

assemble-contrib-toc NPM version

Create a table of contents in the generated HTML, using Cheerio.js

To update this list, download this project, then in the command line run npm i && node docs/repos && grunt.

Contributing

Find a bug? Have a feature request? Please create an Issue. Pull requests are also encouraged. If you find this project useful, please consider "starring" it to show your support! Thanks!

Authors

Jon Schlinkert

Brian Woodward

License

Copyright (c) 2013 Jon Schlinkert, contributors. Released under the MIT license


This file was generated by grunt-readme on Friday, November 15, 2013.

npm loves you