/markdown-it-highlightjs

Preset to use highlight.js with markdown-it.

Primary LanguageJavaScriptThe UnlicenseUnlicense

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

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).