web-infra-dev/rspress v2.0.0-beta.5

on GitHub

Highlights✨

Use shiki v3 by default, drop prism support

related PR: #1672, #2046, #2122

Migrate all code highlighting from prism to shiki in compile time. It is worth noting that some code block syntax will be changed, e.g transformerNotationHighlight

More info: #1891 (comment)

before

import { defineConfig } from 'rspress/config';
import { pluginShiki, createTransformerLineNumber, createTransformerDiff } from '@rspress/plugin-shiki';

export default defineConfig({
  plugins: [
    pluginShiki({
      transformers: [
        createTransformerLineNumber(),
        createTransformerDiff(),
        // createTransformerErrorLevel(),
        // createTransformerHighlight(),
        // createTransformerFocus(),
      ],
    }),
  ],
});

after

import { defineConfig } from 'rspress/config';
import {
  transformerNotationDiff,
} from '@shikijs/transformers';

export default defineConfig({
  markdown: {
    showLineNumber: true,
    shiki: {
        transformers: [
          transformerNotationDiff(),
          // transformerNotationErrorLevel(),
          // transformerNotationFocus(),
          // transformerNotationHighlight(),
      ],
    }
  }
});

Support JSON schema for _meta.json

related PR: #2079

Now you can get type hints in the IDE. For example, in VSCode you can set

// .vscode/settings.json
{
 //...
 "json.schemas": [
    {
      "fileMatch": ["**/_meta.json"],
      "url": "./node_modules/rspress/meta-json-schema.json"
      // or "url": "https://unpkg.com/rspress@2.0.0-beta.5/meta-json-schema.json"
    }
  ],
  // ...
}

What's Changed

New Features 🎉

• feat!: support shiki by default, drop prism support by @SoonIter in #2122
• feat: add _meta.json json schema in rspress/meta-json-schema.json by @SoonIter in #2079
• feat(theme/dynamic-toc): add .rspress-toc-exclude escape hatch by @SoonIter in #2136

Bug Fixes 🐞

• fix(theme/dynamic-toc): skip element in TOC by @SoonIter in #2134

Document 📖

• docs(algolia-search): use new docsearch account and optimize the dark mode by @SoonIter in #2131

Other Changes

• chore: bump rsbuild to v1.3.17 by @JounQin in #2132
• Release v2.0.0-beta.5 by @SoonIter in #2137

Full Changelog: v2.0.0-beta.4...v2.0.0-beta.5