Skip to content
Markdown to HTML conversion on directories using marked.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
src
test
.eslintrc
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
package.json

README.md

marked-directory

NPM Version NPM Downloads Build Status Code Coverage Dependency Status devDependency Status

Markdown to HTML conversion on entire directories using marked

Installation

Add to your project locally

npm install marked-directory --save-dev 

Or add it globally

npm install -g marked-directory

Usage

Example

const md = require('marked-directory');

// returns a promise
md([
    './test/docs/**/*.md', 
    './test/docsBuild',
    './test/docs/',
    './'
]).then(() => console.log('done'));

Options

md(
    [
        './test/docs/**/*.md', // Glob pattern to find files
        './test/docsBuild', // Path to output rendered files
        './test/docs/', // (optional) SearchValue to find in destination paths
        './' // (optional) Replacement value if the above SearchValue is found
    ], {
        logger, // default logging is console.log
        markedOptions // override marked options
    }
);

CLI

Example

marked-directory './test/docs/**/*.md' './test/docsBuild' './test/docs/' './'

Options

marked-directory [glob to markdown files] [output directory] [path searchValue to replace] [path newValue if found by previous arg]
You can’t perform that action at this time.