Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

svelte-prism

jakobrosenberg1.8kISC1.1.6TypeScript support: included

Prismjs for Svelte

prism, prismjs, svelte, code, highlight

readme

svelte-prism

Prebundled with Svelte language support thanks to pngwn

Install

npm i svelte-prism

Usage

<script>
    import Prism from 'svelte-prism'
</script>

<!-- Option one -->
<!-- Using the source prop -->
<Prism language="html" source="{mycode}" />

<!-- Options two -->
<!-- Using the default slot -->
<Prism language="html">
    {mycode}
</Prism>

Inline code

Inline code can be added by adding a string inside Svelte's brackets.

<Prism language="html">
    {`
      <header>
        <h1>Hello World!</h1>
      </header>
    `}
</Prism>

Transform

Code can be transformed by using the transform prop:

<Prism transform={x => x}>...</Prism>

Global transform can be added with:

import { globalConfig } from 'svelte-prism'
globalConfig.transform = x => x
Normalizing whitespace example
import 'prismjs/plugins/normalize-whitespace/prism-normalize-whitespace'
import { globalConfig } from 'svelte-prism'
globalConfig.transform = code => Prism.plugins.NormalizeWhitespace.normalize(code)

Themes

To use a theme, import the CSS to your project. Ie. <link rel='stylesheet' href='https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/themes/prism-okaidia.min.css'>

More themes can be found here https://cdnjs.com/libraries/prism

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.1.6 (2022-07-23)

Bug Fixes

1.1.5 (2022-04-26)

Bug Fixes

1.1.4 (2022-03-15)

Bug Fixes