Syntax Highlighting (and More!) With Prism on a Static Site
Mar 13, 2025 am 11:32 AM
This tutorial demonstrates how to integrate Prism.js syntax highlighting into a Next.js blog, including line numbers and line highlighting. We'll leverage the remark-prism plugin and some custom CSS/JavaScript for advanced features.
Building a Next.js blog often requires nicely formatted code snippets. This guide shows you how to achieve syntax highlighting, line numbers, and individual line highlighting using Prism.js and the remark-prism plugin. While some aspects are more complex than expected, this walkthrough provides solutions.
Prerequisites:
This tutorial uses the Next.js blog starter, but the principles apply to other frameworks. Install the starter and Prism.js:
npm i remark-prism
Basic Prism.js Integration:
Enable remark-prism in your markdownToHtml file (usually located in /lib):
import { remark } from "remark";
import html from "remark-html";
import remarkPrism from "remark-prism";
export default async function markdownToHtml(markdown) {
const result = await remark()
.use(html, { sanitize: false })
.use(remarkPrism, { plugins: ["line-numbers"] })
.process(markdown);
return result.toString();
}
You may need to adjust remark-html usage depending on your version. Import Prism CSS in pages/_app.js:
import "prismjs/themes/prism-tomorrow.css"; import "prismjs/plugins/line-numbers/prism-line-numbers.css"; import "../styles/prism-overrides.css";
Create prism-overrides.css for custom styling.
Adding Line Numbers:
While the line-numbers plugin is included, you need to include the corresponding CSS (as noted in the remark-prism README). You might need adjustments like this in prism-overrides.css:
.line-numbers span.line-numbers-rows {
margin-top: -1px;
}
Highlighting Lines:
The Prism.js line-highlight plugin isn't directly compatible with remark-prism due to static site generation limitations. A workaround uses CSS and JavaScript. Add this CSS to prism-overrides.css:
:root {
--highlight-background: rgb(0 0 0 / 0);
--highlight-width: 0;
}
.line-numbers span.line-numbers-rows > span {
position: relative;
}
.line-numbers span.line-numbers-rows > span::after {
content: " ";
background: var(--highlight-background);
width: var(--highlight-width);
position: absolute;
top: 0;
}
Add a data-line attribute to your Markdown <pre class="brush:php;toolbar:false"></pre> tags (e.g., [data-line="3,8-10"]). In components/post-body.tsx, use JavaScript (example shown, adapt to your structure):
import { useEffect, useRef } from "react";
// ...
const rootRef = useRef(null);
useEffect(() => {
// ... (Code to find <pre class="brush:php;toolbar:false"> elements and highlight lines using data-line attribute) ...
}, []);
// ... (highlightCode function to apply styles based on data-line attribute) ...
This involves parsing the data-line attribute, getting the <pre class="brush:php;toolbar:false"></pre> element's width, and dynamically setting the CSS custom properties to highlight the specified lines.
Line Highlighting without Line Numbers:
To highlight lines without showing line numbers, add a .hide-numbers class and CSS rules to hide the line numbers while preserving highlighting.
Copy-to-Clipboard Feature:
Add a button to copy code snippets. In components/post-body.tsx, append a button to each <pre class="brush:php;toolbar:false"></pre> element using a createCopyButton function that uses navigator.clipboard.writeText. Style the button using CSS.
This comprehensive guide provides a robust solution for integrating Prism.js into your Next.js blog, enabling enhanced code presentation. Remember to adapt the code snippets to your specific project structure.
The above is the detailed content of Syntax Highlighting (and More!) With Prism on a Static Site. For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undress AI Tool
Undress images for free
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Clothoff.io
AI clothes remover
Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
CSS tutorial for creating loading spinners and animations
Jul 07, 2025 am 12:07 AM
There are three ways to create a CSS loading rotator: 1. Use the basic rotator of borders to achieve simple animation through HTML and CSS; 2. Use a custom rotator of multiple points to achieve the jump effect through different delay times; 3. Add a rotator in the button and switch classes through JavaScript to display the loading status. Each approach emphasizes the importance of design details such as color, size, accessibility and performance optimization to enhance the user experience.
Addressing CSS Browser Compatibility issues and prefixes
Jul 07, 2025 am 01:44 AM
To deal with CSS browser compatibility and prefix issues, you need to understand the differences in browser support and use vendor prefixes reasonably. 1. Understand common problems such as Flexbox and Grid support, position:sticky invalid, and animation performance is different; 2. Check CanIuse confirmation feature support status; 3. Correctly use -webkit-, -moz-, -ms-, -o- and other manufacturer prefixes; 4. It is recommended to use Autoprefixer to automatically add prefixes; 5. Install PostCSS and configure browserslist to specify the target browser; 6. Automatically handle compatibility during construction; 7. Modernizr detection features can be used for old projects; 8. No need to pursue consistency of all browsers,
What is the difference between display: inline, display: block, and display: inline-block?
Jul 11, 2025 am 03:25 AM
Themaindifferencesbetweendisplay:inline,block,andinline-blockinHTML/CSSarelayoutbehavior,spaceusage,andstylingcontrol.1.Inlineelementsflowwithtext,don’tstartonnewlines,ignorewidth/height,andonlyapplyhorizontalpadding/margins—idealforinlinetextstyling
Creating custom shapes with css clip-path
Jul 09, 2025 am 01:29 AM
Use the clip-path attribute of CSS to crop elements into custom shapes, such as triangles, circular notches, polygons, etc., without relying on pictures or SVGs. Its advantages include: 1. Supports a variety of basic shapes such as circle, ellipse, polygon, etc.; 2. Responsive adjustment and adaptable to mobile terminals; 3. Easy to animation, and can be combined with hover or JavaScript to achieve dynamic effects; 4. It does not affect the layout flow, and only crops the display area. Common usages are such as circular clip-path:circle (50pxatcenter) and triangle clip-path:polygon (50%0%, 100 0%, 0 0%). Notice
Styling visited links differently with CSS
Jul 11, 2025 am 03:26 AM
Setting the style of links you have visited can improve the user experience, especially in content-intensive websites to help users navigate better. 1. Use CSS's: visited pseudo-class to define the style of the visited link, such as color changes; 2. Note that the browser only allows modification of some attributes due to privacy restrictions; 3. The color selection should be coordinated with the overall style to avoid abruptness; 4. The mobile terminal may not display this effect, and it is recommended to combine it with other visual prompts such as icon auxiliary logos.
How to create responsive images using CSS?
Jul 15, 2025 am 01:10 AM
To create responsive images using CSS, it can be mainly achieved through the following methods: 1. Use max-width:100% and height:auto to allow the image to adapt to the container width while maintaining the proportion; 2. Use HTML's srcset and sizes attributes to intelligently load the image sources adapted to different screens; 3. Use object-fit and object-position to control image cropping and focus display. Together, these methods ensure that the images are presented clearly and beautifully on different devices.
Demystifying CSS Units: px, em, rem, vw, vh comparisons
Jul 08, 2025 am 02:16 AM
The choice of CSS units depends on design requirements and responsive requirements. 1.px is used for fixed size, suitable for precise control but lack of elasticity; 2.em is a relative unit, which is easily caused by the influence of the parent element, while rem is more stable based on the root element and is suitable for global scaling; 3.vw/vh is based on the viewport size, suitable for responsive design, but attention should be paid to the performance under extreme screens; 4. When choosing, it should be determined based on whether responsive adjustments, element hierarchy relationships and viewport dependence. Reasonable use can improve layout flexibility and maintenance.
What are common CSS browser inconsistencies?
Jul 26, 2025 am 07:04 AM
Different browsers have differences in CSS parsing, resulting in inconsistent display effects, mainly including the default style difference, box model calculation method, Flexbox and Grid layout support level, and inconsistent behavior of certain CSS attributes. 1. The default style processing is inconsistent. The solution is to use CSSReset or Normalize.css to unify the initial style; 2. The box model calculation method of the old version of IE is different. It is recommended to use box-sizing:border-box in a unified manner; 3. Flexbox and Grid perform differently in edge cases or in old versions. More tests and use Autoprefixer; 4. Some CSS attribute behaviors are inconsistent. CanIuse must be consulted and downgraded.
