Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add the langPrefix option to the highlight syntax example #309

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add the langPrefix option to the highlight syntax example #309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ var hljs = require('highlight.js') // https://highlightjs.org/

// Actual default values
var md = new Remarkable({
langPrefix: 'hljs language-',
highlight: function (str, lang) {
if (lang && hljs.getLanguage(lang)) {
try {
Expand All @@ -180,6 +181,7 @@ var md = new Remarkable({
});
```

The `langPrefix` option is required to pass the `hljs` class to the code block so that the full Highlight.js styles are applied correctly. Note that it will only work if [your fenced code block has params set, like a language param](https://github.com/jonschlinkert/remarkable/issues/224#issuecomment-339686207).

### Syntax extensions

Expand Down