Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
markdown-it-highlightjs
Advanced tools
Preset to use highlight.js with markdown-it.
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') |
const md = require('markdown-it')()
.use(require('markdown-it-highlightjs'), {
register: {
cypher: require('highlightjs-cypher')
}
})
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}
`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).
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 })
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 })
[3.5.0] - 2021-05-16
FAQs
Preset to use highlight.js with markdown-it.
The npm package markdown-it-highlightjs receives a total of 13,787 weekly downloads. As such, markdown-it-highlightjs popularity was classified as popular.
We found that markdown-it-highlightjs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.