Skip to content

Commit ed1a189

Browse files
committed
chore: update transformers readme
1 parent 562bd7f commit ed1a189

File tree

5 files changed

+87
-71
lines changed

5 files changed

+87
-71
lines changed

examples/next/src/app/index.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
<div>
2-
[`rehype-pretty-code`](https://github.com/atomiks/rehype-pretty-code) <span className="mix-blend-plus-lighter text-zinc-400/80">is a Rehype plugin powered by the</span>
2+
[`rehype-pretty-code`](https://rehype-pretty.pages.dev) <span className="mix-blend-plus-lighter text-zinc-400/80">is a Rehype plugin powered by the</span>
33
[`shiki`](https://github.com/shikijs/shiki) <span className="mix-blend-plus-lighter text-zinc-400/80">syntax highlighter that provides beautiful code blocks for Markdown or MDX. It works on both the server at build-time (avoiding runtime syntax highlighting) and on the client for dynamic highlighting.</span>
44
</div>
55

6+
NOTE: docs are at [rehype-pretty.pages.dev](https://rehype-pretty.pages.dev)
7+
8+
This is the old documentation site, now being used only as Next.js example.
9+
610
## Editor-Grade Highlighting
711

812
<span className="mix-blend-plus-lighter text-zinc-400/80">
@@ -127,7 +131,7 @@ This package is ESM-only and currently supports `shiki{:.string}`
127131

128132
> To use the latest version in Next.js, ensure your config file is `ESM`:
129133
> `next.config.mjs`. Here's a full example:
130-
> [rehype-pretty-code/website/next.config.mjs](https://github.com/atomiks/rehype-pretty-code/blob/master/website/next.config.mjs)
134+
> [rehype-pretty-code/examples/example-next/next.config.mjs](https://github.com/rehype-pretty/rehype-pretty-code/blob/master/examples/next/next.config.mjs)
131135
132136
## Usage
133137

examples/sveltekit/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
},
1313
"dependencies": {
1414
"@rehype-pretty/transformers": "workspace:*",
15-
"@tailwindcss/vite": "4.0.0-alpha.20",
15+
"@tailwindcss/vite": "4.0.0-alpha.31",
1616
"rehype-pretty-code": "workspace:*",
1717
"rehype-slug": "^6.0.0",
1818
"rehype-stringify": "^10.0.1",
1919
"remark-parse": "^11.0.0",
20-
"tailwindcss": "4.0.0-alpha.20"
20+
"tailwindcss": "4.0.0-alpha.31"
2121
},
2222
"devDependencies": {
2323
"@sveltejs/adapter-static": "^3.0.6",

packages/transformers/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
> [!NOTE]
2-
> Currently in **development**.
2+
> **experimental**. Please report any issues you encounter.
33
44
# `@rehype-pretty/transformers`
55

@@ -37,9 +37,9 @@ You can use this as a [`shiki` transformer](https://shiki.style/guide/transforme
3737

3838
- `autoApply`: `boolean` (default: `true`) - Whether to apply line numbers automatically to every code block.
3939

40-
#### Examples
40+
### Examples
4141

42-
##### direct
42+
#### direct
4343

4444
```ts
4545
import { unified } from 'unified'
@@ -67,7 +67,7 @@ You can use this as a [`shiki` transformer](https://shiki.style/guide/transforme
6767
console.log(String(file))
6868
```
6969

70-
##### In React / Next.js
70+
#### In React / Next.js
7171

7272
In Next.js you st it up in `next.config.js` as you'd expect with `jsx: true`
7373

packages/transformers/jsr.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "https://jsr.io/schema/config-file.v1.json",
33
"name": "@rehype-pretty/transformers",
4-
"version": "0.13.2",
4+
"version": "0.13.4",
55
"exports": "./src/index.ts",
66
"publish": {
77
"include": [

pnpm-lock.yaml

Lines changed: 74 additions & 62 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)