astro/packages/astro-prism/README.md
Erika 64432bcb87
Refactor @astrojs/prism, fix Prism component import not working (#4114)
* Upgrade @astrojs/prism to a real package, fix component import not working

* Remove `@astrojs/prism` as a dependency of `astro`

* Update lock file

* Refactor to multiple files

* Oops, can't have astro imports run inside node

* Follow Nate's suggestion on being minors instead of patchs

* Update lockfile
2022-08-02 15:53:18 -04:00

31 lines
617 B
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# @astrojs/prism
Supports Prism highlighting in Astro projects
## Component
This package exports a component to support highlighting inside an Astro file. Example:
```astro
---
import { Prism } from "@astrojs/prism"
---
<Prism lang="js" code={`const foo = 'bar';`} />
```
## Internal
This package exports a `runHighlighterWithAstro` function to highlight while making sure the Astro language is loaded beforehand
```typescript
import { runHighlighterWithAstro } from '@astrojs/prism';
runHighlighterWithAstro(`
---
const helloAstro = 'Hello, Astro!';
---
<div>{helloAstro}</div>
`, 'astro');
```