Skip to content

Markdown-it plugin which adds the ability to include markdown fragment files

License

Notifications You must be signed in to change notification settings

herow-io/markdown-it-include

 
 

Repository files navigation

markdown-it-include

Build Status Coverage Status

NPM

Markdown-it plugin which adds the ability to include markdown fragment files.

Install

node.js, browser:

npm install markdown-it-include --save
bower install markdown-it-include --save

Use

Let's create a markdown which uses a header and a footer from two separate files:

header.md

# This is my header for all my markdowns

footer.md

Follow me on twitter!

Let's assume that header.md and footer.md are located in /in/this/directory.

Now it's your turn to play markdown-it!

var md = require('markdown-it')()
            .use(require('markdown-it-include'), '/in/this/directory');

md.render('!!!include(header.md)!!!\n\n*your content*\n\n!!!include(footer.md)!!!');

It will produce this

<h1>This is my header for all my markdowns</h1>
<p><em>your content</em></p>
<p>Follow me on twitter!</p>

Disclaimer

This purposefully doesn't conform to any spec or discussion related to CommonMark.

License

MIT

About

Markdown-it plugin which adds the ability to include markdown fragment files

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 66.4%
  • Makefile 33.6%