To help you get started, we've collected the most common ways that hast-util-to-html is being used within popular public projects.

orgapp / orgajs / packages / gatsby-transformer-orga / src / extend-node-type.ts View on Github

const filesToCopy = new Map()
    const highlight = pluginOptions.noHighlight !== true
    const handlers = { link: handleLink }

    // offset the levels
    const firstHeadline = select('headline', body)
    const offset = firstHeadline ? firstHeadline.level - 1 : 0
    if (offset > 0) {
      body = map(body, node => {
        if (node.type !== `headline`) return node
        return { ...node, level: node.level - offset }
      })
    }

    const hast = toHAST(body, { highlight, handlers })
    const html = hastToHTML(hast, { allowDangerousHTML: true })
    await Promise.all(Array.from(filesToCopy, async ([linkPath, newFilePath]) => {
      // Don't copy anything is the file already exists at the location.
      if (!fsExtra.existsSync(newFilePath)) {
        try {
          await fsExtra.ensureDir(dirname(newFilePath))
          await fsExtra.copy(linkPath, newFilePath)
        } catch (err) {
          console.error(`error copying file`, err)
        }
      }
    }))
    return html

    function handleLink(h, node) {
      const { uri, desc } = node

View more ways to use hast-util-to-html

hast-util-to-html

[![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size] [![Sponsors][sponsors-badge]][collective] [![Backers][backers-badge]][collective] [![Chat][chat-badge]][chat]

[hast][] utility to serialize hast as HTML.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • toHtml(tree[, options])
  • CharacterReferences
  • Options
  • Quote
  • Space
• Syntax
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a utility that turns a hast tree into a string of HTML.

When should I use this?

You can use this utility when you want to get the serialized HTML that is represented by the syntax tree, either because you’re done with the syntax tree, or because you’re integrating with another tool that does not support syntax trees.

This utility has many options to configure how the HTML is serialized. These options help when building tools that make output pretty (such as formatters) or ugly (such as minifiers).

The utility [hast-util-from-html][hast-util-from-html] does the inverse of this utility. It turns HTML into hast.

The rehype plugin [rehype-stringify][rehype-stringify] wraps this utility to also serialize HTML at a higher-level (easier) abstraction.

Install

This package is [ESM only][esm]. In Node.js (version 16+), install with [npm][]:

npm install hast-util-to-html

In Deno with [esm.sh][esmsh]:

import {toHtml} from "https://esm.sh/hast-util-to-html@9"

In browsers with [esm.sh][esmsh]:

Use

npm install hastscript hast-util-to-html

import {h} from 'hastscript'
import {toHtml} from 'hast-util-to-html'

var tree = h('.alpha', [
  'bravo ',
  h('b', 'charlie'),
  ' delta ',
  h('a.echo', {download: true}, 'foxtrot')
])

console.log(toHtml(tree))

Yields:

<div class="alpha">bravo <b>charlie</b> delta <a download="" class="echo">foxtrot</a></div>

API

This package exports the identifier [toHtml][api-to-html]. There is no default export.

toHtml(tree[, options])

Serialize hast as HTML.

Parameters

• tree ([Node][node] or Array) — tree to serialize
• options ([Options][api-options], optional) — configuration

Returns

Serialized HTML (string).

CharacterReferences

How to serialize character references (TypeScript type).

Fields

useNamedReferences

Prefer named character references (&) where possible (boolean, default: false).

omitOptionalSemicolons

Whether to omit semicolons when possible (boolean, default: false).

> ⚠️ Note: this creates what HTML calls “parse errors” but is otherwise > still valid HTML — don’t use this except when building a minifier. > Omitting semicolons is possible for certain named and numeric references in > some cases.

useShortestReferences

Prefer the shortest possible reference, if that results in less bytes (boolean, default: false).

> ⚠️ Note: useNamedReferences can be omitted when using > useShortestReferences.

Options

Configuration (TypeScript type).

Fields

allowDangerousCharacters

Do not encode some characters which cause XSS vulnerabilities in older browsers (boolean, default: false).

> ⚠️ Danger: only set this if you completely trust the content.

allowDangerousHtml

Allow raw nodes and insert them as raw HTML (boolean, default: false).

When false, Raw nodes are encoded.

> ⚠️ Danger: only set this if you completely trust the content.

allowParseErrors

Do not encode characters which cause parse errors (even though they work), to save bytes (boolean, default: false).

Not used in the SVG space.

> 👉 Note: intentionally creates parse errors in markup (how parse errors > are handled is well defined, so this works but isn’t pretty).

bogusComments

Use “bogus comments” instead of comments to save byes: instead of (boolean, default: false).

> 👉 Note: intentionally creates parse errors in markup (how parse errors > are handled is well defined, so this works but isn’t pretty).

characterReferences

Configure how to serialize character references ([CharacterReferences][api-character-references], optional).

closeEmptyElements

Close SVG elements without any content with slash (/) on the opening tag instead of an end tag: `