Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jGleitz/markdown-it-prism
Highlight code blocks in markdown-it using prism
https://github.com/jGleitz/markdown-it-prism
code-highlight markdown markdown-it prismjs
Last synced: about 2 months ago
JSON representation
Highlight code blocks in markdown-it using prism
- Host: GitHub
- URL: https://github.com/jGleitz/markdown-it-prism
- Owner: jGleitz
- License: mit
- Created: 2016-10-16T21:20:47.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-07-31T19:37:35.000Z (about 2 months ago)
- Last Synced: 2024-08-01T02:14:13.575Z (about 2 months ago)
- Topics: code-highlight, markdown, markdown-it, prismjs
- Language: TypeScript
- Size: 8.11 MB
- Stars: 85
- Watchers: 6
- Forks: 22
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vite - `markdown-it-prism` - [Prism](https://prismjs.com/) for syntax highlighting (Pre-packed / Plugins)
README
# markdown-it-prism [](https://travis-ci.org/jGleitz/markdown-it-prism) [](https://badge.fury.io/js/markdown-it-prism) [](https://badge.fury.io/bo/markdown-it-prism)
> [markdown-it](https://github.com/markdown-it/markdown-it) plugin to highlight code blocks using [Prism](http://prismjs.com/)
## Usage
```js
const md = require('markdown-it')();
const prism = require('markdown-it-prism');
md.use(prism, options);
```
The plugin will insert the necessary markup into all code blocks. [Include one of Prism’s stylesheets](http://prismjs.com/#basic-usage) in
your HTML to get highlighted code.
### Options
The `options` object may contain:
| Name | Description | Default |
|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| `highlightInlineCode` | Whether to highlight inline code. | `false` |
| `plugins` | Array of [Prism Plugins](http://prismjs.com/#plugins) to load. The names to use can be found [here](https://github.com/PrismJS/prism/tree/master/plugins). Please note that some prism plugins (notably line-numbers) rely on the DOM being present and can thus not be used with this package (see [#1](https://github.com/jGleitz/markdown-it-prism/issues/1)). | `[]` |
| `init` | A function called after setting up prism. Will receive the prism instance as only argument. Useful for plugins needing further intialisation. | `() => {}` |
| `defaultLanguageForUnknown` | The language to use for code blocks that specify a language that Prism does not know. No default will be used if this option is `undefined`. | `undefined` |
| `defaultLanguageForUnspecified` | The language to use for code block that do not specify a language. No default will be used if this option is `undefined`. | `undefined` |
| `defaultLanguage` | Shorthand to set both `defaultLanguageForUnknown` and `defaultLanguageForUnspecified` to the same value. | `undefined` |
### Inline Code
When `highlightInlineCode` is set, inline code will be highlighted just like fenced code blocks are.
To specifiy the language of inline code, add `{language=}` after the code segment:
```markdown
`class Demo { };`{language=cpp}
```
This syntax is compatible with [markdown-it-attrs](https://github.com/arve0/markdown-it-attrs):
The `language=` part will be stripped, but everything else between `{` and `}` will work
with [markdown-it-attrs](https://github.com/arve0/markdown-it-attrs) as usual.
## Usage with Webpack
If you want to use this plugin together with [Webpack](https://webpack.js.org/), you need to import all languages you intend to use:
```javascript
import MarkdownIt from 'markdown-it';
import prism from 'markdown-it-prism';
import "prismjs/components/prism-clike"
import "prismjs/components/prism-java"
function component() {
const md = new MarkdownIt();
md.use(prism);
const element = document.createElement('div');
element.innerHTML = md.render(`
Here is some *code*:
\`\`\`java
public class Test {
public void foo() {}
}
\`\`\`
`);
return element;
}
document.body.appendChild(component());
```
*Beware*: Prisms languages have dependencies onto each other. You need to import the languages together with their dependencies in the
correct order.