<commit_before>
# gulp-ljs
This is a gulp plugin for [ljs](https://github.com/phadej/ljs) - Literate Javascript.
Note, that there are two ways of literating your code:
* .lit.js -> .md and .lit.js -> js (see [literate](https://www.npmjs.org/package/literate))
* .js -> .md \*THIS\*

Everything inside `/*` and `*/` is handled as markup. Your code will be transformed into the markup code environment.
Just to give you an idea:
```
/*
   # Header
   Prosa..
   * item1
   * item2
*/
var awesome = "Awesome";
console.log(awesome);
```

## Usage
Install `gulp-ljs`:
```
npm install gulp-ljs --save-dev
```
Using this plugin is pretty straight forward. For the sake of sanity I replace *automatically* the extension of the filepath.
While the gulp-guys will hate this, I think that this this could save your day (when you forgot to set a replace pipe).
```
var ljs = require('gulp-ljs');

gulp.task('literate', function () {
  gulp.src('path/**/*.js')
    .pipe(ljs())
    .pipe(gulp.dest('path/'))
});

```

## Options
### code
Don't include the code in the markup file. Default: true.
```
var ljs = require('gulp-ljs');

gulp.task('literate', function () {
  gulp.src('path/**/*.js')
    .pipe(ljs({code : false}))
    .pipe(gulp.dest('path/'))
});
```
<commit_msg>fixed README<commit_after>
# gulp-ljs
This is a gulp plugin for [ljs](https://github.com/phadej/ljs) - Literate Javascript.
Note, that there are two ways of literating your code:
* .lit.js -> .md and .lit.js -> .js (see [literate](https://www.npmjs.org/package/literate))
* .js -> .md \*THIS\*

Everything inside `/*` and `*/` is handled as markup. Your code will be transformed into the markup code environment.
Just to give you an idea:
```
/*
   # Literate me :-)
   Prosa..
   * item1
   * item2
*/
var awesome = "Awesome";
console.log(awesome);
```

## Usage
Install `gulp-ljs`:
```
npm install gulp-ljs --save-dev
```
Using this plugin is pretty straight forward. For the sake of sanity I replace *automatically* the extension of the filepath.
While the gulp-guys will hate this, I think that this this could save your day (when you forgot to set a replace pipe).
```
var ljs = require('gulp-ljs');

gulp.task('literate', function () {
  gulp.src('path/**/*.js')
    .pipe(ljs())
    .pipe(gulp.dest('path/'))
});

```

## Options
### code
Don't include the code in the markup file. `Default: true`
```
var ljs = require('gulp-ljs');

gulp.task('literate', function () {
  gulp.src('path/**/*.js')
    .pipe(ljs({code : false}))
    .pipe(gulp.dest('path/'))
});
```

{'fraction_non_alphanumeric': 0.1754731861198738, 'fraction_numerical': 0.0015772870662460567, 'mean_word_length': 3.4902654867256637, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, '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': '6752581', 'n_tokens_mistral': 917, 'n_tokens_neox': 865, 'n_words': 284}