DEV Community

loading...

How to parse nonhard-coded markdown in NextJS with Syntax Highlighting

glowtoad123 profile image Alonzo ・2 min read

Instead of writing individual html pages or embedding an article from an external blog site, you may want to make your own customization to your articles and to make use of markdown's simplicity to write blogs alongside NextJS's incremental static site generation for fast loading and dynamic data. However, if you have used a markdown parser, you probably have realized that while it gets the job done, you would prefer to have syntax highlighting in your code snippets rather than just having text that looks somewhat different from your paragraphs. If you have faced this, there is a solution to this. First you need to install two packages: markdown-it and highlight.js.

// if you're using npm

npm i highlight.js
npm i markdown-it

//if you're using yarn

yarn add highlight.js
yarn add markdown-it

Enter fullscreen mode Exit fullscreen mode

First, at the top of your file, you need to import hljs from highlight.js and then import MarkdownIt from markdown-it.

import hljs from 'highlight.js'
import MarkdownIt from 'markdown-it'
Enter fullscreen mode Exit fullscreen mode

After that, you need to create a const (let's call it md) that is equal to a MarkdownIt function that incorporates hljs that was imported. This will allow Markdown-It to recognize parts of your markdown data that has code and will apply syntax highlighting for that language. It should look something like this.

    const md = new MarkdownIt({
        highlight: function (str, lang) {
          if (lang && hljs.getLanguage(lang)) {
            try {
              return '<pre class="hljs"><code>' +
                     hljs.highlight(lang, str, true).value +
                     '</code></pre>';
            } catch (err) {console.log(err)}
          }

          return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
        }
      });

Enter fullscreen mode Exit fullscreen mode

After that, you can create a div element with an attribute called dangerouslySetInnerHTML. That attribute should contain an object with a propterty called: __html (yes with two underscores). This should be equal to md.render(/your markdown data/, /language/) (assuming that you named the const md). It should look like this:

<div id={styles.blog} dangerouslySetInnerHTML={{__html: md.render(/*your markdown data*/, */language*/)}}></div>

Enter fullscreen mode Exit fullscreen mode

Finally to make sure that syntax highlighting actually appear, you need to import a css file from highligh.js in your _app.js file. Highlight.js has alot of css styles so you can experiment with those. To find those styles, you can go to the node_modules folder, then inside that folder go to the highlight.js folder, and then styles. The import statement should look something like this:

import 'highlight.js/styles/atelier-forest-light.css'
Enter fullscreen mode Exit fullscreen mode

In the end, you will have a blog article with syntax highlighting. E.G This site

Discussion (0)

Forem Open with the Forem app