<commit_before># grunt-markdown

This grunt task takes a set of markdown files and converts them to HTML. It supports [GFM](http://github.github.com/github-flavored-markdown/) with code highlighting. The code highlighting is done using [highlight.js](http://softwaremaniacs.org/soft/highlight/en/).

## Getting Started
Install this grunt plugin next to your project's [grunt.js gruntfile](http://gruntjs.com/getting-started) with:

```shell
npm install grunt-markdown
```

Then add this line to your gruntfile:

```javascript
grunt.loadNpmTasks('grunt-markdown');
```

## Documentation
Creating a markdown task is simple. For the basic functionality add the following config in your gruntfile:

```javascript
grunt.initConfig({
  markdown: {
    all: {
      files: ['docs/src/*.md'],
      dest: 'docs/html/'
    }  
  }  
});

```

Here is an example config using all of the options:

```javascript
grunt.initConfig({
  markdown: {
    all: {
      files: ['docs/src/*.md'],
      dest: 'docs/html/',
      template 'myTemplate.jst',
      options: {
        gfm: true,
        highlight: 'manual',
        codeLines: {
          before: '<span>',
          after: '</span>'
        }
      }
    }  
  }  
});

```
These are the properties that the `markdown` task accepts:

* `files`: The list of markdown files<commit_msg>fix(README): missing colon in json<commit_after># grunt-markdown

This grunt task takes a set of markdown files and converts them to HTML. It supports [GFM](http://github.github.com/github-flavored-markdown/) with code highlighting. The code highlighting is done using [highlight.js](http://softwaremaniacs.org/soft/highlight/en/).

## Getting Started
Install this grunt plugin next to your project's [grunt.js gruntfile](http://gruntjs.com/getting-started) with:

```shell
npm install grunt-markdown
```

Then add this line to your gruntfile:

```javascript
grunt.loadNpmTasks('grunt-markdown');
```

## Documentation
Creating a markdown task is simple. For the basic functionality add the following config in your gruntfile:

```javascript
grunt.initConfig({
  markdown: {
    all: {
      files: ['docs/src/*.md'],
      dest: 'docs/html/'
    }  
  }  
});

```

Here is an example config using all of the options:

```javascript
grunt.initConfig({
  markdown: {
    all: {
      files: ['docs/src/*.md'],
      dest: 'docs/html/',
      template: 'myTemplate.jst',
      options: {
        gfm: true,
        highlight: 'manual',
        codeLines: {
          before: '<span>',
          after: '</span>'
        }
      }
    }  
  }  
});

```
These are the properties that the `markdown` task accepts:

* `files`: The list of markdown files
{'fraction_non_alphanumeric': 0.13378176382660686, 'fraction_numerical': 0.0, 'mean_word_length': 3.049924357034796, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4056872', 'n_tokens_mistral': 870, 'n_tokens_neox': 815, 'n_words': 255}