markdown-it-highlightjs
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/markdown-it-highlightjs package

    3.6.0 • Public • Published

    markdown-it-highlightjs npm version

    Preset to use highlight.js with markdown-it.

    Usage

    const md = require('markdown-it')()
      .use(require('markdown-it-highlightjs'), opts)
    
    // All code blocks will be highlighted.

    The opts object can contain:

    Name Type Description Default
    auto boolean Whether to automatically detect language if not specified. true
    code boolean Whether to add the hljs class to raw code blocks (not fenced blocks). true
    register object Register other languages which are not included in the standard pack. null
    inline boolean Whether to highlight inline code. false
    hljs object Provide the instance of highlight.js to use for highlighting require('highlight.js')

    Register languages

    const md = require('markdown-it')()
      .use(require('markdown-it-highlightjs'), {
        register: {
          cypher: require('highlightjs-cypher')
        }
      })

    Inline code highlighting

    You can enable inline code highlighting by setting inline to true:

    const md = require('markdown-it')()
      .use(require('markdown-it-highlightjs'), { inline: true })

    You can specify the language for inline code using Pandoc syntax:

    `x=4`{.js}

    or Kramdown IAL syntax:

    `x=4`{:.js}

    If you do not specify a language, then highlight.js will attempt to guess the language if auto is true (which it is by default).

    Provide the highlight.js instance

    You can specify the hljs option to override the default highlight.js instance with your own:

    const hljs = require('highlight.js/lib/core')
    
    hljs.registerLanguage(
      'javascript',
      require('highlight.js/lib/languages/javascript')
    )
    
    const md = require('markdown-it')()
      .use(require('markdown-it-highlightjs'), { hljs })

    Core plugin

    You may import the core markdown-it-highlightjs plugin directly, without any default options. You must specify an instance of highlight.js for the hljs option.

    const hljs = require('highlight.js/lib/core')
    const md = require('markdown-it')()
      .use(require('markdown-it-highlightjs/core'), { hljs })

    Install

    npm i markdown-it-highlightjs

    DownloadsWeekly Downloads

    4,450

    Version

    3.6.0

    License

    Unlicense

    Unpacked Size

    7.28 kB

    Total Files

    5

    Last publish

    Collaborators

    • valeriangalliat