astro/packages/astro-prism/README.md
Bjorn Lu 8e3cb20b5c
Format markdown files (#7439)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2023-06-26 11:34:13 +08:00

34 lines
623 B
Markdown

# @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'
);
```