expressive-code

v0.38.3

Published

2 months ago

A text marking & annotation engine for presenting source code on the web.

Downloads

205,900

0High
0Medium
0Low

hippotastic

expressive-code

A framework-agnostic wrapper package that provides convenient access to the key packages of Expressive Code, an engine for presenting source code on the web.

Instead of having to install and manage multiple Expressive Code packages separately, this package includes both the core engine and all default plugins as dependencies and exports them.

Included packages:

When should I use this?

Using this package directly is only recommended for advanced use cases, e.g. to create integrations of Expressive Code into other tools and frameworks.

If you just want to render code blocks on your website, you should use one of the higher-level packages instead, e.g. astro-expressive-code or rehype-expressive-code for code blocks in markdown / MDX documents.

Documentation

Read the Expressive Code docs to learn more about the features provided by Expressive Code.

Installation

npm install expressive-code

Usage example

// File: generate-html.mjs
import { ExpressiveCode } from 'expressive-code'
import { toHtml } from 'expressive-code/hast'
import fs from 'fs'

const ec = new ExpressiveCode()

// Get base styles that should be included on the page
// (they are independent of the rendered code blocks)
const baseStyles = await ec.getBaseStyles()
const themeStyles = await ec.getThemeStyles()
const jsModules = await ec.getJsModules()

// Render some example code to AST
const { renderedGroupAst, styles: blockStyles } = await ec.render({
  code: 'console.log("Hello world!")',
  language: 'js',
  meta: '',
})

// Convert the rendered AST to HTML
let htmlContent = toHtml(renderedGroupAst)

// Collect styles and add them before the HTML content
const stylesToPrepend = []
stylesToPrepend.push(baseStyles)
stylesToPrepend.push(themeStyles)
stylesToPrepend.push(...blockStyles)

const styleContent = `<style> ${[...stylesToPrepend].join('')} </style>`
const jsContent = `<script type="module"> ${[...jsModules].join('')} </script>`

const htmlDocument = `
<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>

    ${styleContent}

    ${jsContent}
</head>
<body>
    ${htmlContent}
</body>
</html>
`
// Output HTML to the console
console.log(htmlDocument)

// Run `node generate-html.mjs` to generate the HTML file
// and open it in the browser
fs.writeFileSync('index.html', htmlDocument)

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

expressive-code

When should I use this?

Documentation

Installation

Usage example