Using Prism with Next.js

arvi9 — Wed, 04 Oct 2023 03:20:32 +0000

Prism is a popular syntax highlighter commonly used with Markdown. This example shows how to use Prism with Next.js. Use the theme dropdown in the header to switch syntax highlighting themes.

Next.js uses getStaticPaths/getStaticProps to generate static pages. These functions are not bundled client-side, so you can write server-side code directly. For example, you can read Markdown files from the filesystem (fs) – including parsing front matter with gray-matter. For example, let's assume you have a Markdown file located at docs/my-post.js.

We can retrieve that file's contents using getDocBySlug('my-post').

// lib/docs.js

import fs from 'fs';
import { join } from 'path';
import matter from 'gray-matter';

const docsDirectory = join(process.cwd(), 'docs');

export function getDocBySlug(slug) {
const realSlug = slug.replace(/.md$/, '');
const fullPath = join(docsDirectory, ${realSlug}.md);
const fileContents = fs.readFileSync(fullPath, 'utf8');
const { data, content } = matter(fileContents);

return { slug: realSlug, meta: data, content };
}
Then, we can transform the raw Markdown into HTML using remark plugins.

// lib/markdown.js

import { remark } from 'remark';
import html from 'remark-html';
import prism from 'remark-prism';

export default async function markdownToHtml(markdown) {
const result = await remark()
// https://github.com/sergioramos/remark-prism/issues/265
.use(html, { sanitize: false })
.use(prism)
.process(markdown);
return result.toString();
}
Passing the content returned by getDocBySlug('my-post') into markdownToHtml(content) would convert a Markdown file like this:

title: 'My First Post'

description: 'My very first blog post'

My First Post

I love using Next.js

const doc = getDocBySlug(params.slug);

into this HTML, which includes the proper elements and class names.

My First Post

I love using Next.js



    

      const doc = getDocBySlug(params.slug);

Deploy Your Own
View the source code and deploy your own. You can add new Markdown files to docs/ and see them live instantly!

DEV Community: arvi9

Using Prism with Next.js

description: 'My very first blog post'

My First Post

My First Post