Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

markdown-it-include

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

markdown-it-include

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

  • 1.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.8K
decreased by-34.24%
Maintainers
1
Weekly downloads
 
Created
Source

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

Keywords

FAQs

Package last updated on 15 Dec 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc