gulp-marked-man v0.3.1

gulp-marked-man

A gulp plugin that converts markdown files to man pages.

Usage

You can configure the way marked-man parses your input files by providing an options object.

gulp-marked-man looks for the following options:

• preserveExtensions if given extensions are not removed from markdown files.

Input File Extensions

By default gulp-marked-man will remove the file extension of the input files. This allows your syntax highlighting for .md files and facilitates sectioned manfiles I.E. mydoc.1 mydoc.5.

You can override this by passing in {preserveExtensions: true}.

Extensions removed:

var rename = require('gulp-rename');
var markedMan = require('gulp-marked-man');

gulp.src('./test/fixtures/simple.1.md')
  .pipe(markedMan())
  .pipe(gulp.dest('./dist/'));
  // -> ./dist/simple.1

Extensions preserved:

var rename = require('gulp-rename');
var markedMan = require('gulp-marked-man');

gulp.src('./test/fixtures/simple.1.md')
  .pipe(markedMan({preserveExtensions: true}))
  .pipe(gulp.dest('./dist/'));
  // -> ./dist/simple.1.md

##LICENSE

The MIT License (MIT)

Copyright (c) 2014 Joseph Spencer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.