Code Monkey home page Code Monkey logo

markdown-it-inject-linenumbers's Introduction

markdown-it-inject-linenumbers

Insert line numbers to support sync scrolling for the markdown-it markdown parser.

Inject the source line numbers into the final HTML. This gives you the anchor points to implement synchronized scrolling.

lorem => <p class="line" data-source-line="0">lorem</p>

Inline elements are not supported. Only the following block level elements are currently supported:

  • headings
  • paragraphs
  • list items
  • tables

This plugin was built using the markdown-it demo sync scrolling as a starting point.

Install

node.js, browser:

npm install markdown-it-inject-linenumbers --save
bower install markdown-it-inject-linenumbers --save

Use

var md = require('markdown-it')()
            .use(require('markdown-it-inject-linenumbers'));

md.render('lorem') // => '<p class="source-line" data-source-line="0">lorem</p>'

Differences in browser. If you load script directly into the page, without package system, module will add itself globally as window.markdownitInjectLinenumbers.

License

MIT

markdown-it-inject-linenumbers's People

Contributors

digitalmoksha avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.