docs: fix code-documentation inconsistencies (#63)

- Fix core/README.md: replace non-existent registerLanguage with actual initHighlighter API
- Remove highlight.css references: Shiki themes are controlled via props, not separate CSS imports
- Update all CHANGELOG files to remove outdated highlight.css references
- Clarify that highlight() is async and returns a Promise
- Update migration guide to reflect actual v3 API

Author: simonguo

README.md

@@ -362,7 +362,7 @@ Major changes in v3.0.0 modernize the architecture and usage. Here’s how to up
   - After (v3): `import CodeView from 'react-code-view'` or `import { CodeView } from '@react-code-view/react'`
 - Styles: Use the new CSS entry points.
   - Before (v2): Less files (e.g., `react-code-view/less/styles.less`)
-  - After (v3): `import 'react-code-view/styles'` and optional syntax theme `import 'react-code-view/styles/highlight'`
+  - After (v3): `import 'react-code-view/styles'`
 - Build tool integration: Replace legacy Webpack markdown loader with the unified unplugin across tools.
   - Before (v2): `webpack-md-loader` and custom loader config
   - After (v3): `@react-code-view/unplugin` for Vite/Webpack/Rollup/esbuild/Rspack (see examples above)

RELEASE_NOTES_v3.0.0.md

@@ -16,6 +16,6 @@
   - `useCodeExecution` effect behavior stabilized; consumers relying on previous implicit re-execution may need to explicitly update `code` or pass `dependencies`
   - Package structure reorganized across `packages/*`; import paths may need updates according to exports
   - Imports: `CodeView` is now also a default export in `@react-code-view/react` and re-exported by `react-code-view`; prefer `import CodeView from 'react-code-view'` or adjust named imports accordingly
-  - Styles: Less entries were removed; switch to `import 'react-code-view/styles'` and optional `import 'react-code-view/styles/highlight'`
+  - Styles: Less entries were removed; switch to `import 'react-code-view/styles'`
   - Build integration: Legacy `webpack-md-loader` is removed; migrate to unified `@react-code-view/unplugin` for Vite/Webpack/Rollup/esbuild/Rspack
   - Tooling: Minimum requirements updated to Node >=18 and PNPM >=8 for the monorepo/dev workflow

examples/vite/src/docs/example.md

@@ -41,11 +41,12 @@ const result = await transformMarkdown(markdown, {
 ### Direct Highlighting
 
 ```js
-import { highlight, registerLanguage } from '@react-code-view/core';
+import { highlight, initHighlighter } from '@react-code-view/core';
 
-await registerLanguage('python');
+// Initialize highlighter (optional, will auto-initialize on first use)
+await initHighlighter();
 
-const highlighted = highlight('print("Hello")', { language: 'python' });
+const highlighted = await highlight('print("Hello")', { language: 'python' });
 ```
 
 ## API
@@ -61,11 +62,15 @@ Transform markdown to an ES module string.
 
 ### `highlight(code, options?)`
 
-Highlight code with syntax highlighting.
+Highlight code with syntax highlighting using Shiki.
 
-### `registerLanguage(name)`
+**Options:**
+- `language` - Programming language (e.g., 'javascript', 'python')
+- `theme` - Shiki theme (default: 'github-light')
+
+### `initHighlighter()`
 
-Register a language for highlighting.
+Initialize the Shiki highlighter. Called automatically on first use.
 
 ## License
 

examples/vite/src/test-parse.js

@@ -16,7 +16,7 @@
   - `useCodeExecution` effect behavior stabilized; consumers relying on previous implicit re-execution may need to explicitly update `code` or pass `dependencies`
   - Package structure reorganized across `packages/*`; import paths may need updates according to exports
   - Imports: `CodeView` is now also a default export in `@react-code-view/react` and re-exported by `react-code-view`; prefer `import CodeView from 'react-code-view'` or adjust named imports accordingly
-  - Styles: Less entries were removed; switch to `import 'react-code-view/styles'` and optional `import 'react-code-view/styles/highlight'`
+  - Styles: Less entries were removed; switch to `import 'react-code-view/styles'`
   - Build integration: Legacy `webpack-md-loader` is removed; migrate to unified `@react-code-view/unplugin` for Vite/Webpack/Rollup/esbuild/Rspack
   - Tooling: Minimum requirements updated to Node >=18 and PNPM >=8 for the monorepo/dev workflow
 

packages/core/CHANGELOG.md

@@ -145,9 +145,8 @@ Import the base styles:
 
 ```tsx
 import 'react-code-view/styles';
-// or specific files
+// or
 import 'react-code-view/styles/index.css';
-import 'react-code-view/styles/highlight.css';
 ```
 
 Use theme classes:

packages/core/README.md

@@ -16,7 +16,7 @@
   - `useCodeExecution` effect behavior stabilized; consumers relying on previous implicit re-execution may need to explicitly update `code` or pass `dependencies`
   - Package structure reorganized across `packages/*`; import paths may need updates according to exports
   - Imports: `CodeView` is now also a default export in `@react-code-view/react` and re-exported by `react-code-view`; prefer `import CodeView from 'react-code-view'` or adjust named imports accordingly
-  - Styles: Less entries were removed; switch to `import 'react-code-view/styles'` and optional `import 'react-code-view/styles/highlight'`
+  - Styles: Less entries were removed; switch to `import 'react-code-view/styles'`
   - Build integration: Legacy `webpack-md-loader` is removed; migrate to unified `@react-code-view/unplugin` for Vite/Webpack/Rollup/esbuild/Rspack
   - Tooling: Minimum requirements updated to Node >=18 and PNPM >=8 for the monorepo/dev workflow
 

packages/react-code-view/CHANGELOG.md

@@ -16,7 +16,7 @@
   - `useCodeExecution` effect behavior stabilized; consumers relying on previous implicit re-execution may need to explicitly update `code` or pass `dependencies`
   - Package structure reorganized across `packages/*`; import paths may need updates according to exports
   - Imports: `CodeView` is now also a default export in `@react-code-view/react` and re-exported by `react-code-view`; prefer `import CodeView from 'react-code-view'` or adjust named imports accordingly
-  - Styles: Less entries were removed; switch to `import 'react-code-view/styles'` and optional `import 'react-code-view/styles/highlight'`
+  - Styles: Less entries were removed; switch to `import 'react-code-view/styles'`
   - Build integration: Legacy `webpack-md-loader` is removed; migrate to unified `@react-code-view/unplugin` for Vite/Webpack/Rollup/esbuild/Rspack
   - Tooling: Minimum requirements updated to Node >=18 and PNPM >=8 for the monorepo/dev workflow